Struct FilePath 

#[repr(C)]
pub struct FilePath {
    pub inner: AzString,
}

FFI-safe path type with OOP-style methods

This wraps a string path and provides method-based access to file operations.

Fields

inner: AzString

Implementations

impl FilePath

pub const fn new(path: AzString) -> Self

Creates a new path from a string

pub fn empty() -> Self

Creates an empty path

pub fn from_str(s: &str) -> Self

Creates a path from a string slice

pub fn get_temp_dir() -> Self

Returns the system temporary directory

pub fn get_current_dir() -> Result<Self, FileError>

Returns the current working directory

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

pub fn get_home_dir() -> Option<Self>

Returns the user’s home directory (e.g., /home/username on Linux, C:\Users\username on Windows)

pub fn get_cache_dir() -> Option<Self>

Returns the user’s cache directory (e.g., ~/.cache on Linux, ~/Library/Caches on macOS)

pub fn get_config_dir() -> Option<Self>

Returns the user’s config directory (e.g., ~/.config on Linux, ~/Library/Application Support on macOS)

pub fn get_config_local_dir() -> Option<Self>

Returns the user’s local config directory (e.g., ~/.config on Linux, ~/Library/Application Support on macOS)

pub fn get_data_dir() -> Option<Self>

Returns the user’s data directory (e.g., ~/.local/share on Linux, ~/Library/Application Support on macOS)

pub fn get_data_local_dir() -> Option<Self>

Returns the user’s local data directory (e.g., ~/.local/share on Linux, ~/Library/Application Support on macOS)

pub fn get_desktop_dir() -> Option<Self>

Returns the user’s desktop directory (e.g., ~/Desktop)

pub fn get_document_dir() -> Option<Self>

Returns the user’s documents directory (e.g., ~/Documents)

pub fn get_download_dir() -> Option<Self>

Returns the user’s downloads directory (e.g., ~/Downloads)

pub fn get_executable_dir() -> Option<Self>

Returns the user’s executable directory (e.g., ~/.local/bin on Linux)

pub fn get_font_dir() -> Option<Self>

Returns the user’s font directory (e.g., ~/.local/share/fonts on Linux, ~/Library/Fonts on macOS)

pub fn get_picture_dir() -> Option<Self>

Returns the user’s pictures directory (e.g., ~/Pictures)

pub fn get_preference_dir() -> Option<Self>

Returns the user’s preference directory (e.g., ~/.config on Linux, ~/Library/Preferences on macOS)

pub fn get_public_dir() -> Option<Self>

Returns the user’s public directory (e.g., ~/Public)

pub fn get_runtime_dir() -> Option<Self>

Returns the user’s runtime directory (e.g., /run/user/1000 on Linux)

pub fn get_state_dir() -> Option<Self>

Returns the user’s state directory (e.g., ~/.local/state on Linux)

pub fn get_audio_dir() -> Option<Self>

Returns the user’s audio directory (e.g., ~/Music)

pub fn get_video_dir() -> Option<Self>

Returns the user’s video directory (e.g., ~/Videos)

pub fn get_template_dir() -> Option<Self>

Returns the user’s templates directory

pub fn join(&self, other: &Self) -> Self

Joins this path with another path component

pub fn join_str(&self, component: &AzString) -> Self

Joins this path with a string component

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

Returns the parent directory of this path

pub fn file_name(&self) -> Option<AzString>

Returns the file name component of this path

pub fn extension(&self) -> Option<AzString>

Returns the file extension of this path

pub fn exists(&self) -> bool

Checks if the path exists on the filesystem

pub fn is_file(&self) -> bool

Checks if the path is a file

pub fn is_dir(&self) -> bool

Checks if the path is a directory

pub fn is_absolute(&self) -> bool

Checks if the path is absolute

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

Creates this directory and all parent directories

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

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

Creates this directory (parent must exist)

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

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

Removes this file

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

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

Removes this directory (must be empty)

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

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

Removes this directory and all contents

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

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

Reads the entire file at this path as bytes

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

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

Reads the entire file at this path as a string

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

pub fn write_bytes(&self, data: &U8Vec) -> Result<EmptyStruct, FileError>

Writes bytes to the file at this path

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

pub fn write_string(&self, data: &AzString) -> Result<EmptyStruct, FileError>

Writes a string to the file at this path

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

pub fn copy_to(&self, dest: &Self) -> Result<u64, FileError>

Copies a file from this path to another path

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

pub fn rename_to(&self, dest: &Self) -> Result<EmptyStruct, FileError>

Renames/moves a file from this path to another path

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

pub fn as_str(&self) -> &str

Returns the path as a string reference

pub fn as_string(&self) -> AzString

Returns the path as an AzString

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

Lists directory contents

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

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

Returns metadata about the file/directory

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

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

Makes the path canonical (absolute, with no . or .. components)

Errors

Returns a FileError if the filesystem operation fails (e.g. path not found, permission denied, or an I/O error).

Trait Implementations

impl Clone for FilePath

fn clone(&self) -> FilePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilePath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FilePath

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FilePath

impl From<&str> for FilePath

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<AzString> for FilePath

fn from(s: AzString) -> Self

Converts to this type from the input type.

impl From<String> for FilePath

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for FilePath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FilePath

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FilePath