Struct WasiFilesystem 

pub struct WasiFilesystem;

A helper struct which implements HasData for the wasi:filesystem APIs.

This can be useful when directly calling add_to_linker functions directly, such as [wasmtime_wasi::p2::bindings::filesystem::types::add_to_linker] as the D type parameter. See HasData for more information about the type parameter’s purpose.

When using this type you can skip the WasiFilesystemView trait, for example.

Examples

use wasmtime::component::{Linker, ResourceTable};
use wasmtime::{Engine, Result, Config};
use wasmtime_wasi::filesystem::*;

struct MyStoreState {
    table: ResourceTable,
    filesystem: WasiFilesystemCtx,
}

fn main() -> Result<()> {
    let mut config = Config::new();
    config.async_support(true);
    let engine = Engine::new(&config)?;
    let mut linker = Linker::new(&engine);

    wasmtime_wasi::p2::bindings::filesystem::types::add_to_linker::<MyStoreState, WasiFilesystem>(
        &mut linker,
        |state| WasiFilesystemCtxView {
            table: &mut state.table,
            ctx: &mut state.filesystem,
        },
    )?;
    Ok(())
}

Trait Implementations

impl HasData for WasiFilesystem

type Data<'a> = WasiFilesystemCtxView<'a>

The data associated with this trait implementation, chiefly used as a generic associated type to allow plumbing the 'a lifetime into the definition here.

impl HostDescriptorWithStore for WasiFilesystem

Available on crate feature p3 only.

async fn read_via_stream<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, offset: Filesize, ) -> Result<(StreamReader<u8>, FutureReader<Result<(), ErrorCode>>)>

Return a stream for reading from a file.

async fn write_via_stream<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, data: StreamReader<u8>, offset: Filesize, ) -> FilesystemResult<()>

Return a stream for writing to a file, if available.

async fn append_via_stream<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, data: StreamReader<u8>, ) -> FilesystemResult<()>

Return a stream for appending to a file, if available.

async fn advise<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, offset: Filesize, length: Filesize, advice: Advice, ) -> FilesystemResult<()>

Provide file advisory information on a descriptor.

async fn sync_data<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, ) -> FilesystemResult<()>

Synchronize the data of a file to disk.

async fn get_flags<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, ) -> FilesystemResult<DescriptorFlags>

Get flags associated with a descriptor.

async fn get_type<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, ) -> FilesystemResult<DescriptorType>

Get the dynamic type of a descriptor.

async fn set_size<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, size: Filesize, ) -> FilesystemResult<()>

Adjust the size of an open file. If this increases the file’s size, the extra bytes are filled with zeros.

async fn set_times<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, data_access_timestamp: NewTimestamp, data_modification_timestamp: NewTimestamp, ) -> FilesystemResult<()>

Adjust the timestamps of an open file or directory.

async fn read_directory<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, ) -> Result<(StreamReader<DirectoryEntry>, FutureReader<Result<(), ErrorCode>>)>

Read directory entries from a directory.

async fn sync<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, ) -> FilesystemResult<()>

Synchronize the data and metadata of a file to disk.

async fn create_directory_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, path: String, ) -> FilesystemResult<()>

Create a directory.

async fn stat<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, ) -> FilesystemResult<DescriptorStat>

Return the attributes of an open file or directory.

async fn stat_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, path_flags: PathFlags, path: String, ) -> FilesystemResult<DescriptorStat>

Return the attributes of a file or directory.

async fn set_times_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, path_flags: PathFlags, path: String, data_access_timestamp: NewTimestamp, data_modification_timestamp: NewTimestamp, ) -> FilesystemResult<()>

Adjust the timestamps of a file or directory.

async fn link_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, old_path_flags: PathFlags, old_path: String, new_fd: Resource<Descriptor>, new_path: String, ) -> FilesystemResult<()>

Create a hard link.

async fn open_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, path_flags: PathFlags, path: String, open_flags: OpenFlags, flags: DescriptorFlags, ) -> FilesystemResult<Resource<Descriptor>>

Open a file or directory.

async fn readlink_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, path: String, ) -> FilesystemResult<String>

Read the contents of a symbolic link.

async fn remove_directory_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, path: String, ) -> FilesystemResult<()>

Remove a directory.

async fn rename_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, old_path: String, new_fd: Resource<Descriptor>, new_path: String, ) -> FilesystemResult<()>

Rename a filesystem object.

async fn symlink_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, old_path: String, new_path: String, ) -> FilesystemResult<()>

Create a symbolic link (also known as a “symlink”).

async fn unlink_file_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, path: String, ) -> FilesystemResult<()>

Unlink a filesystem object that is not a directory.

async fn is_same_object<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, other: Resource<Descriptor>, ) -> Result<bool>

Test whether two descriptors refer to the same filesystem object.

async fn metadata_hash<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, ) -> FilesystemResult<MetadataHashValue>

Return a hash of the metadata associated with a filesystem object referred to by a descriptor.

async fn metadata_hash_at<U>( store: &Accessor<U, Self>, fd: Resource<Descriptor>, path_flags: PathFlags, path: String, ) -> FilesystemResult<MetadataHashValue>

Return a hash of the metadata associated with a filesystem object referred to by a directory descriptor and a relative path.