Struct Path

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

A borrowed path type. The implementation is very similar to the standard library’s std::path::Path. However, this implementation is more lightweight and allows for std-less usage.

Implementations

impl Path

pub const ROOT: &'static Path

pub const EMPTY: &'static Path

pub const SYSTEM: &'static Path

Contains the OS core, including the kernel, init system, and critical drivers. Prevents modification by regular users.

pub const DEVICES: &'static Path

Stores system-wide settings in a structured format (e.g., JSON, TOML).

pub const CONFIGURATION: &'static Path

Hardware devices, symlinks for human-friendly names.

pub const SHARED_CONFIGURATION: &'static Path

Contains the shared configurations between applications.

pub const DATA: &'static Path

Binaries data.

pub const SHARED_DATA: &'static Path

Shared data between binaries.

pub const BINARIES: &'static Path

Contains the system’s binaries, including the shell and other executables.

pub const USERS: &'static Path

Contains the user’s data, including documents, downloads, and other files.

pub const TEMPORARY: &'static Path

Contains temporary files, including logs and caches.

pub const LOGS: &'static Path

Contains logs, including system logs and application logs.

pub const fn from_str(path: &str) -> &Path

Safety

The caller must ensure that the string is a valid path string.

pub fn new<S: AsRef<str> + ?Sized>(path: &S) -> &Path

Safety

The caller must ensure that the string is a valid path string.

pub fn is_valid(&self) -> bool

pub fn is_absolute(&self) -> bool

pub fn is_root(&self) -> bool

pub fn is_empty(&self) -> bool

pub fn is_canonical(&self) -> bool

pub fn go_parent(&self) -> Option<&Path>

pub fn get_file_prefix(&self) -> Option<&str>

pub fn get_file_name(&self) -> Option<&str>

pub fn get_extension(&self) -> Option<&str>

pub fn set_extension(&self, extension: &str) -> Option<PathOwned>

pub fn strip_prefix<'b>(&'b self, path_prefix: &Path) -> Option<&'b Path>

pub fn strip_prefix_absolute<'b>( &'b self, path_prefix: &Path, ) -> Option<&'b Path>

pub fn strip_suffix<'b>(&'b self, path_suffix: &Path) -> Option<&'b Path>

pub fn get_components(&self) -> Components<'_>

pub fn join(&self, path: &Path) -> Option<PathOwned>

pub fn append(&self, path: &str) -> Option<PathOwned>

pub fn get_length(&self) -> usize

pub fn as_str(&self) -> &str

Trait Implementations

impl AsRef<Path> for Path

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Path> for PathOwned

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Path> for str

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for &Path

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Path> for PathOwned

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Debug for Path

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

Formats the value using the given formatter.

impl Hash for Path

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

Feeds this value into the given Hasher.

impl PartialEq for Path

fn eq(&self, other: &Path) -> 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 ToOwned for Path

type Owned = PathOwned

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for Path

impl StructuralPartialEq for Path