Struct FileAssetWriter

pub struct FileAssetWriter { /* private fields */ }

A writer for the local filesystem.

Implementations

impl FileAssetWriter

pub fn new<P>(path: P, create_root: bool) -> FileAssetWriter

where P: AsRef<Path> + Debug,

Creates a new FileAssetWriter at a path relative to the executable’s directory, optionally watching for changes.

Trait Implementations

impl AssetWriter for FileAssetWriter

async fn write<'a>( &'a self, path: &'a Path, ) -> Result<Box<dyn AsyncWrite + Send + Sync + Unpin>, AssetWriterError>

Writes the full asset bytes at the provided path.

async fn write_meta<'a>( &'a self, path: &'a Path, ) -> Result<Box<dyn AsyncWrite + Send + Sync + Unpin>, AssetWriterError>

Writes the full asset meta bytes at the provided path. This should not include storage specific extensions like .meta.

async fn remove<'a>(&'a self, path: &'a Path) -> Result<(), AssetWriterError>

Removes the asset stored at the given path.

async fn remove_meta<'a>( &'a self, path: &'a Path, ) -> Result<(), AssetWriterError>

Removes the asset meta stored at the given path. This should not include storage specific extensions like .meta.

async fn create_directory<'a>( &'a self, path: &'a Path, ) -> Result<(), AssetWriterError>

Creates a directory at the given path, including all parent directories if they do not already exist.

async fn remove_directory<'a>( &'a self, path: &'a Path, ) -> Result<(), AssetWriterError>

Removes the directory at the given path, including all assets and directories in that directory.

async fn remove_empty_directory<'a>( &'a self, path: &'a Path, ) -> Result<(), AssetWriterError>

Removes the directory at the given path, but only if it is completely empty. This will return an error if the directory is not empty.

async fn remove_assets_in_directory<'a>( &'a self, path: &'a Path, ) -> Result<(), AssetWriterError>

Removes all assets (and directories) in this directory, resulting in an empty directory.

async fn rename<'a>( &'a self, old_path: &'a Path, new_path: &'a Path, ) -> Result<(), AssetWriterError>

Renames the asset at old_path to new_path

async fn rename_meta<'a>( &'a self, old_path: &'a Path, new_path: &'a Path, ) -> Result<(), AssetWriterError>

Renames the asset meta for the asset at old_path to new_path. This should not include storage specific extensions like .meta.

fn write_bytes<'a>( &'a self, path: &'a Path, bytes: &'a [u8], ) -> impl ConditionalSendFuture

Writes the asset bytes to the given path.

fn write_meta_bytes<'a>( &'a self, path: &'a Path, bytes: &'a [u8], ) -> impl ConditionalSendFuture

Writes the asset meta bytes to the given path.