camino

Struct Utf8PrefixComponent

source
pub struct Utf8PrefixComponent<'a>(/* private fields */);
Expand description

A structure wrapping a Windows path prefix as well as its unparsed string representation.

In addition to the parsed Utf8Prefix information returned by kind, Utf8PrefixComponent also holds the raw and unparsed str slice, returned by as_str.

Instances of this struct can be obtained by matching against the Prefix variant on Utf8Component.

Does not occur on Unix.

§Examples

use camino::{Utf8Component, Utf8Path, Utf8Prefix};
use std::ffi::OsStr;

let path = Utf8Path::new(r"c:\you\later\");
match path.components().next().unwrap() {
    Utf8Component::Prefix(prefix_component) => {
        assert_eq!(Utf8Prefix::Disk(b'C'), prefix_component.kind());
        assert_eq!("c:", prefix_component.as_str());
    }
    _ => unreachable!(),
}

Implementations§

source§

impl<'a> Utf8PrefixComponent<'a>

source

pub fn kind(&self) -> Utf8Prefix<'a>

Returns the parsed prefix data.

See Utf8Prefix’s documentation for more information on the different kinds of prefixes.

source

pub fn as_str(&self) -> &'a str

Returns the str slice for this prefix.

source

pub fn as_os_str(&self) -> &'a OsStr

Returns the raw OsStr slice for this prefix.

Trait Implementations§

source§

impl<'a> Clone for Utf8PrefixComponent<'a>

source§

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

Returns a copy 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<'a> Debug for Utf8PrefixComponent<'a>

source§

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

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

impl<'a> Display for Utf8PrefixComponent<'a>

source§

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

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

impl<'a> Hash for Utf8PrefixComponent<'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 Utf8PrefixComponent<'a>

source§

fn cmp(&self, other: &Utf8PrefixComponent<'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<'a> PartialEq for Utf8PrefixComponent<'a>

source§

fn eq(&self, other: &Utf8PrefixComponent<'a>) -> 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 Utf8PrefixComponent<'a>

source§

fn partial_cmp(&self, other: &Utf8PrefixComponent<'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> Copy for Utf8PrefixComponent<'a>

source§

impl<'a> Eq for Utf8PrefixComponent<'a>

source§

impl<'a> StructuralPartialEq for Utf8PrefixComponent<'a>

Auto Trait Implementations§

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. 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.