Struct async_std::path::PrefixComponent

pub struct PrefixComponent<'a> { /* fields omitted */ }

[−] Expand description

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

In addition to the parsed Prefix information returned by kind, PrefixComponent also holds the raw and unparsed OsStr slice, returned by as_os_str.

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

Does not occur on Unix.

Examples

use std::path::{Component, Path, Prefix};
use std::ffi::OsStr;

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

Implementations

impl<'a> PrefixComponent<'a>

pub fn kind(&self) -> Prefix<'a>[−]

Returns the parsed prefix data.

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

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

Returns the raw OsStr slice for this prefix.

Trait Implementations

impl<'a> Clone for PrefixComponent<'a>

[+] Show hidden undocumented items

pub fn clone(&self) -> PrefixComponent<'a>[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<'a> Debug for PrefixComponent<'a>

[+] Show hidden undocumented items

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl<'_> Hash for PrefixComponent<'_>

[+] Show hidden undocumented items

pub fn hash<H>(&self, h: &mut H) where
    H: Hasher, [−]

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'_> Ord for PrefixComponent<'_>

[+] Show hidden undocumented items

pub fn cmp(&self, other: &PrefixComponent<'_>) -> Ordering[−]

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl<'a> PartialEq<PrefixComponent<'a>> for PrefixComponent<'a>

[+] Show hidden undocumented items

pub fn eq(&self, other: &PrefixComponent<'a>) -> bool[−]

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

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl<'a> PartialOrd<PrefixComponent<'a>> for PrefixComponent<'a>

[+] Show hidden undocumented items

pub fn partial_cmp(&self, other: &PrefixComponent<'a>) -> Option<Ordering>[−]

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

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn le(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub 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 PrefixComponent<'a>

impl<'a> Eq for PrefixComponent<'a>

impl<'a> StructuralEq for PrefixComponent<'a>