Struct 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 an 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(url_or_path: impl AsRef<str>) -> Self

Constructs a new File object.

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 relative_path(&self, another: &File) -> String

Finds the relative path from the File object to another File object. If they point to the same path, this function returns a single dot (".").

Example

let path = File::new("app://foo/bar").relative_path(&File::new("app://qux/foo"));
assert_eq!(path.as_str(), "../../qux/foo");

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

Resolves relative path.

Example

let file = File::new("app://foo/bar").resolve_path("zxc/../abc");
assert_eq!(file.url().as_str(), "app://foo/bar/abc");

pub fn name(&self) -> String

The last portion of this path.

Example

assert_eq!(File::new("app://foo.txt").name(), "foo.txt".to_owned());

pub fn name_without_extension(&self, extension: impl AsRef<str>) -> String

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

Example

assert_eq!(File::new("app://foo.txt").name_without_extension(".txt"), "foo".to_owned());

pub fn extension(&self) -> String

The filename extension. This includes the dot.

Example

assert_eq!(File::new("app://foo.txt").extension(), ".txt".to_owned());

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 application_directory() -> Self

Returns a reference to the application installation directory. This is equivalent to (File::new"app://"").

pub fn application_storage_directory() -> Self

Returns a reference to the application private directory. This is equivalent to the URL File::new("app-storage://").

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 working directory. This is used primarily for command-line applications.

pub fn exists(&self) -> bool

Determines whether the referenced path exists.

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 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<(), FileError>

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<(), FileError>

Asynchronously 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<(), FileError>

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<(), FileError>

Asynchronously 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>, FileError>

Read file contents as bytes.

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

Asynchronously read file contents as bytes.

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

Read file contents as a UTF-8 string.

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

Asynchronously read file contents as a UTF-8 string.

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

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<(), FileError>

Deletes empty directory.

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

Asynchronously deletes empty directory.

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

Deletes directory after deleting all its contents.

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

Asynchronously deletes directory after deleting all its contents.

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

Deletes file.

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

Asynchronously deletes file.

pub fn move_to(&self, to: &File) -> Result<(), FileError>

Move a file or directory to another path specified by the to parameter, replacing the original file if to already exists.

pub async fn move_to_async(&self, to: &File) -> Result<(), FileError>

Asynchronously move a file or directory to another path specified by the to parameter, replacing the original file if to already exists.

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

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<(), FileError>

Asynchronously 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<(), FileError>

Writes bytes to a file.

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

Asynchronously writes bytes to a file.

pub fn creation_date(&self) -> Result<DateTime<Local>, FileError>

Creation date.

pub async fn creation_date_async(&self) -> Result<DateTime<Local>, FileError>

Creation date.

pub fn modification_date(&self) -> Result<DateTime<Local>, FileError>

Modification date.

pub async fn modification_date_async( &self, ) -> Result<DateTime<Local>, FileError>

Modification date.

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

Size of the file in bytes.

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

Size of the file in bytes.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for File

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for File

impl StructuralPartialEq for File