Path

Struct Path 

Source
pub struct Path<'a>(/* private fields */);
Expand description

Reference path type.

Paths are mostly arbitrary sequences of bytes, with two restrictions:

  • The path cannot contain any null bytes.
  • Each component of the path must be no longer than 255 bytes.

Implementations§

Source§

impl<'a> Path<'a>

Source

pub const SEPARATOR: u8 = 47u8

Unix path separator.

Source

pub const ROOT: Path<'static>

Root path, equivalent to /.

Source

pub fn new<P>(p: &'a P) -> Self
where P: AsRef<[u8]> + ?Sized,

Create a new Path.

This panics if the input is invalid, use Path::try_from if error handling is desired.

§Panics

Panics if the path contains any null bytes or if a component of the path is longer than 255 bytes.

Source

pub fn is_absolute(self) -> bool

Get whether the path is absolute (starts with /).

Source

pub fn display(self) -> BytesDisplay<'a>

Get an object that implements Display to allow conveniently printing paths that may or may not be valid UTF-8. Non-UTF-8 characters will be replaced with ‘�’.

Source

pub fn join(self, path: impl AsRef<[u8]>) -> PathBuf

Create a new PathBuf joining self with path.

This will add a separator if needed. Note that if the argument is an absolute path, the returned value will be equal to path.

§Panics

Panics if the argument is not a valid path.

Source

pub fn components(self) -> Components<'a>

Get an iterator over each Component in the path.

Source

pub fn to_str(self) -> Result<&'a str, Utf8Error>

Convert to a &str if the path is valid UTF-8.

Trait Implementations§

Source§

impl<'a> AsRef<[u8]> for Path<'a>

Source§

fn as_ref(&self) -> &'a [u8]

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

impl<'a> Clone for Path<'a>

Source§

fn clone(&self) -> Path<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Path<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> From<Path<'a>> for &'a Path

Available on crate feature std and Unix only.
Source§

fn from(p: Path<'a>) -> &'a Path

Converts to this type from the input type.
Source§

impl<'a> From<Path<'a>> for PathBuf

Source§

fn from(p: Path<'a>) -> Self

Converts to this type from the input type.
Source§

impl<'a> Hash for Path<'a>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a> Ord for Path<'a>

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T> PartialEq<T> for Path<'_>
where T: AsRef<[u8]>,

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<'a> PartialOrd for Path<'a>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl<'a> TryFrom<&'a [u8]> for Path<'a>

Source§

type Error = PathError

The type returned in the event of a conversion error.
Source§

fn try_from(s: &'a [u8]) -> Result<Self, PathError>

Performs the conversion.
Source§

impl<'a, const N: usize> TryFrom<&'a [u8; N]> for Path<'a>

Source§

type Error = PathError

The type returned in the event of a conversion error.
Source§

fn try_from(a: &'a [u8; N]) -> Result<Self, PathError>

Performs the conversion.
Source§

impl<'a> TryFrom<&'a OsStr> for Path<'a>

Available on crate feature std and Unix only.
Source§

type Error = PathError

The type returned in the event of a conversion error.
Source§

fn try_from(p: &'a OsStr) -> Result<Self, PathError>

Performs the conversion.
Source§

impl<'a> TryFrom<&'a Path> for Path<'a>

Available on crate feature std only.
Source§

type Error = PathError

The type returned in the event of a conversion error.
Source§

fn try_from(p: &'a Path) -> Result<Self, PathError>

Performs the conversion.
Source§

impl<'a> TryFrom<&'a PathBuf> for Path<'a>

Source§

type Error = PathError

The type returned in the event of a conversion error.
Source§

fn try_from(p: &'a PathBuf) -> Result<Self, PathError>

Performs the conversion.
Source§

impl<'a> TryFrom<&'a String> for Path<'a>

Source§

type Error = PathError

The type returned in the event of a conversion error.
Source§

fn try_from(s: &'a String) -> Result<Self, PathError>

Performs the conversion.
Source§

impl<'a> TryFrom<&'a str> for Path<'a>

Source§

type Error = PathError

The type returned in the event of a conversion error.
Source§

fn try_from(s: &'a str) -> Result<Self, PathError>

Performs the conversion.
Source§

impl<'a> Copy for Path<'a>

Source§

impl<'a> Eq for Path<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Path<'a>

§

impl<'a> RefUnwindSafe for Path<'a>

§

impl<'a> Send for Path<'a>

§

impl<'a> Sync for Path<'a>

§

impl<'a> Unpin for Path<'a>

§

impl<'a> UnwindSafe for Path<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.