Struct rialight_filesystem::File

pub struct File { /* private fields */ }

Represents a path to a file or directory.

Constructing a File object

File can be constructed either with a path or a URL. The following URL schemes are supported:

• file:
• app: file in the application installation directory
• app-storage: file in the application private directory

The File constructor performs implicit normalization of the given path argument.

Implementations

impl File

pub fn new<T: AsRef<str>>(url_or_path: T) -> Self

Constructs a new File object.

pub fn name(&self) -> String

The last portion of this path.

pub fn name_without_suffix<S: AsRef<str>>(&self, suffix: S) -> String

The last portion of this path, excluding the given suffix.

pub fn extension(&self) -> String

The filename extension. This includes the dot.

pub fn application_directory() -> Self

Returns a reference to the application installation directory. This is equivalent to the URL app://.

pub fn application_storage_directory() -> Self

Returns a reference to the application private directory. This is equivalent to the URL app-storage://.

pub fn url(&self) -> String

The URL for this file path.

pub fn native_path(&self) -> String

The full path in the host operating system representation.

pub fn resolve_path<S: AsRef<str>>(&self, arg: S) -> Self

Resolves relative path.

pub fn relative_path(&self, another: &File) -> String

Relative path from the File object to another File object.

pub fn downloads_directory() -> Option<File>

The user downloads directory.

pub fn documents_directory() -> Option<File>

The user documents directory.

pub fn executable_directory() -> Option<File>

The executable directory.

pub fn user_directory() -> Option<File>

pub fn pictures_directory() -> Option<File>

The user pictures directory.

pub fn videos_directory() -> Option<File>

The user videos directory.

pub fn working_directory() -> Option<File>

The application’s working directory (used primarily for command-line applications).

pub fn application_based_native_path(&self) -> PathBuf

Native path of the File object. If the File object was constructed from app: or app-storage: scheme, then its path is resolved to the internal application directory.

pub fn exists(&self) -> bool

Determines whether the referenced path exists.s

pub fn is_directory(&self) -> bool

Determines whether the referenced path is a directory.

pub fn is_file(&self) -> bool

Determines whether the referenced path is a file.

pub fn is_symbolic_link(&self) -> bool

Determines whether the referenced path is a symbolic link.

pub fn parent(&self) -> Option<File>

The directory that contains the file or directory referenced by the File object.

This property is identical to the return value of resolve_path("..") except that the parent of a root directory is None.

pub fn separator() -> String

The host operating system’s path component separator character.

pub fn canonicalize(&self) -> File

Returns a canonicalization of the File path.

pub async fn canonicalize_async(&self) -> File

Returns a canonicalization of the File path.

pub fn copy_to(&self, new_location: &File) -> Result<(), IoError>

Copies the file at the location specified by the File object to the location specified by the new_location parameter.

This method will overwrite the contents of new_location.

pub async fn copy_to_async(&self, new_location: &File) -> Result<(), IoError>

Copies the file at the location specified by the File object to the location specified by the new_location parameter.

This method will overwrite the contents of new_location.

pub fn create_directory(&self) -> Result<(), IoError>

Creates the specified directory and any necessary parent directories. If the directory already exists, no action is taken.

pub async fn create_directory_async(&self) -> Result<(), IoError>

Creates the specified directory and any necessary parent directories. If the directory already exists, no action is taken.

pub fn read_bytes(&self) -> Result<Vec<u8>, IoError>

Read file contents as bytes.

pub async fn read_bytes_async(&self) -> Result<Vec<u8>, IoError>

Read file contents as bytes.

pub fn read_utf8(&self) -> Result<String, IoError>

Read file contents as UTF-8 string.

pub async fn read_utf8_async(&self) -> Result<String, IoError>

Read file contents as UTF-8 string.

pub fn get_directory_listing(&self) -> Result<Vec<File>, IoError>

Returns a vector of File objects corresponding to files and directories in the directory represented by the File object.

pub fn delete_empty_directory(&self) -> Result<(), IoError>

Deletes empty directory.

pub async fn delete_empty_directory_async(&self) -> Result<(), IoError>

Deletes empty directory.

pub fn delete_all_directory(&self) -> Result<(), IoError>

Deletes directory after deleting all its contents.

pub async fn delete_all_directory_async(&self) -> Result<(), IoError>

Deletes directory after deleting all its contents.

pub fn delete_file(&self) -> Result<(), IoError>

Deletes file.

pub async fn delete_file_async(&self) -> Result<(), IoError>

Deletes file.

pub fn rename(&self, to: &File) -> Result<(), IoError>

Rename a file or directory to a new name specified by the to parameter, replacing the original file if to already exists.

pub async fn rename_async(&self, to: &File) -> Result<(), IoError>

Rename a file or directory to a new name specified by the to parameter, replacing the original file if to already exists.

pub fn write<B: AsRef<[u8]>>(&self, b: B) -> Result<(), IoError>

Writes bytes to a file.

pub async fn write_async<B: AsRef<[u8]>>(&self, b: B) -> Result<(), IoError>

Writes bytes to a file.

pub fn creation_date(&self) -> Result<SystemTime, IoError>

Creation date.

pub async fn creation_date_async(&self) -> Result<SystemTime, IoError>

Creation date.

pub fn modification_date(&self) -> Result<SystemTime, IoError>

Modification date.

pub async fn modification_date_async(&self) -> Result<SystemTime, IoError>

Modification date.

pub fn size(&self) -> Result<i64, IoError>

Size of the file in bytes.

pub async fn size_async(&self) -> Result<i64, IoError>

Size of the file in bytes.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<File> for File

fn eq(&self, other: &File) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for File

impl StructuralEq for File

impl StructuralPartialEq for File