Struct agera::file::DirectoryReference

pub struct DirectoryReference(/* private fields */);

DirectoryReference represents a reference to a directory in the file system.

Browser support

Unlike with File objects, all operations on DirectoryReference are asynchronous and are designed to be compatible with the browser.

Implementations

impl DirectoryReference

pub fn name(&self) -> String

The name of a directory. This operation returns the last segment of the full directory path, including any file extensions.

pub async fn entries(&self) -> Result<Vec<FileSystemReference>>

Returns the entries of a directory.

pub async fn get_directory(&self, name: &str) -> Result<DirectoryReference>

Attempts to get a directory entry. name is taken as the entry filename.

Errors

• Returns Err if the specified filename is invalid.
• Returns Err if the directory does not exist or is a file.

pub async fn get_directory_or_create( &self, name: &str ) -> Result<DirectoryReference>

Attempts to get a directory entry or creates it if it does not exist. name is taken as the entry filename.

Errors

• Returns Err if the specified filename is invalid.
• Returns Err if a file of the specified filename already exists.

pub async fn get_file(&self, name: &str) -> Result<FileReference>

Attempts to get a file entry. name is taken as the entry filename.

Errors

• Returns Err if the specified filename is invalid.
• Returns Err if the file does not exist or is a directory.

pub async fn get_file_or_create(&self, name: &str) -> Result<FileReference>

Attempts to get a file entry or creates it if it does not exist. name is taken as the entry filename.

Errors

• Returns Err if the specified filename is invalid.
• Returns Err if a directory of the specified filename already exists.

pub async fn delete_empty_directory(&self, name: &str) -> Result<()>

Deletes an empty entry directory. name is taken as the entry filename.

pub async fn delete_directory_all(&self, name: &str) -> Result<()>

Deletes a directory entry recursively. name is taken as the entry filename.

pub async fn delete_file(&self, name: &str) -> Result<()>

Deletes a file entry. name is taken as the entry filename.

Trait Implementations

impl Clone for DirectoryReference

fn clone(&self) -> DirectoryReference

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<DirectoryReference> for FileSystemReference

fn from(value: DirectoryReference) -> Self

Converts to this type from the input type.

impl TryFrom<FileSystemReference> for DirectoryReference

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: FileSystemReference) -> Result<Self, Self::Error>

Performs the conversion.