Struct camino::Utf8PrefixComponent

#[repr(transparent)]
pub struct Utf8PrefixComponent<'a>(_);

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

impl<'a> Utf8PrefixComponent<'a>

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

Returns the parsed prefix data.

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

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

Returns the str slice for this prefix.

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

Returns the raw OsStr slice for this prefix.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Utf8PrefixComponent<'a>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<'a> Hash for Utf8PrefixComponent<'a>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Utf8PrefixComponent<'a>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a> PartialEq<Utf8PrefixComponent<'a>> for Utf8PrefixComponent<'a>

fn eq(&self, other: &Utf8PrefixComponent<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd<Utf8PrefixComponent<'a>> for Utf8PrefixComponent<'a>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> Copy for Utf8PrefixComponent<'a>

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

impl<'a> StructuralEq for Utf8PrefixComponent<'a>

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