Struct Path

pub struct Path { /* private fields */ }

A slice of a path (akin to str).

More details about the overall approach can be found in the module documentation.

Implementations

impl Path

pub fn new<'a, P: AsRef<FsStr> + 'a>(path: P) -> &'a Self

Directly wraps a string slice as a Path slice.

This is a cost-free conversion.

Examples

use vexide::path::Path;

Path::new("foo.txt");

You can create Paths from Strings, or even other Paths:

use alloc::string::String;
use vexide::path::Path;

let string = String::from("foo.txt");
let from_string = Path::new(&string);
let from_path = Path::new(&from_string);
assert_eq!(from_string, from_path);

pub const fn as_fs_str(&self) -> &FsStr

Yields the underlying FsStr slice.

Examples

use vexide::{path::Path, fs::FsStr};

let fs_str = Path::new("foo.txt").as_os_str();
assert_eq!(os_str, FsStr::new("foo.txt"));

Trait Implementations

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<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 PathBuf

fn as_ref(&self) -> &Path

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

impl Borrow<Path> for PathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Hash for Path

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

Feeds this value into the given Hasher.

impl Ord for Path

fn cmp(&self, other: &Path) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq for Path

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

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

const 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 PartialOrd for Path

fn partial_cmp(&self, other: &Path) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Path

impl StructuralPartialEq for Path