Docs4dev
Docs
rust / latest / std / path / struct.prefixcomponent.html

Struct std::path::PrefixComponent

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

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

source 
impl<'a> PrefixComponent<'a>
source 
pub fn kind(&self) -> Prefix<'a>

Returns the parsed prefix data.

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

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

Returns the raw OsStr slice for this prefix.

Trait Implementations

source 
impl<'a> Clone for PrefixComponent<'a>
source 
fn clone(&self) -> PrefixComponent<'a>
Returns a copy of the value. Read more
source 
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source 
impl<'a> Debug for PrefixComponent<'a>
source 
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source 
impl Hash for PrefixComponent<'_>
source 
fn hash<H: Hasher>(&self, h: &mut H)
Feeds this value into the given Hasher. Read more
1.3.0source 
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 Ord for PrefixComponent<'_>
source 
fn cmp(&self, other: &Self) -> Ordering
This method returns an Ordering between self and other. Read more
1.21.0source 
fn max(self, other: Self) -> Self
where
    Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0source 
fn min(self, other: Self) -> Self
where
    Self: Sized,
Compares and returns the minimum of two values. Read more
1.50.0source 
fn clamp(self, min: Self, max: Self) -> Self
where
    Self: Sized + PartialOrd,
Restrict a value to a certain interval. Read more
source 
impl<'a> PartialEq for PrefixComponent<'a>
source 
fn eq(&self, other: &PrefixComponent<'a>) -> bool
This method tests for self and other values to be equal, and is used by ==.
source 
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.
source 
impl<'a> PartialOrd for PrefixComponent<'a>
source 
fn partial_cmp(&self, other: &PrefixComponent<'a>) -> Option<Ordering>
This method returns an ordering between self and other values if one exists. Read more
source 
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
source 
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
source 
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self and other) and is used by the > operator. Read more
source 
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source 
impl<'a> Copy for PrefixComponent<'a>
source 
impl<'a> Eq for PrefixComponent<'a>
source 
impl<'a> StructuralEq for PrefixComponent<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for PrefixComponent<'a>
impl<'a> Send for PrefixComponent<'a>
impl<'a> Sync for PrefixComponent<'a>
impl<'a> Unpin for PrefixComponent<'a>
impl<'a> UnwindSafe for PrefixComponent<'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> 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,
 
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>,
 
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>,
 
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.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/path/struct.PrefixComponent.html