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::core::path::Path;

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

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

use alloc::string::String;
use vexide::core::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::core::{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.