# Struct std::path::PrefixComponent 1.0.0[−][src]

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

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!(),
    }

Run

## Implementations

### `impl<'a> PrefixComponent<'a>`[src]

#### `pub fn kind(&self) -> Prefix<'a>`[src]

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`[src]

Returns the raw `OsStr` slice for this prefix.

## Trait Implementations

### `impl<'a> Clone for PrefixComponent<'a>`[src]

#### `fn clone(&self) -> PrefixComponent<'a>`[src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`[src]

Performs copy-assignment from `source`. Read more

### `impl<'a> Copy for PrefixComponent<'a>`[src]

### `impl<'a> Debug for PrefixComponent<'a>`[src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

Formats the value using the given formatter. Read more

### `impl<'a> Eq for PrefixComponent<'a>`[src]

### `impl Hash for PrefixComponent<'_>`[src]

#### `fn hash<H: Hasher>(&self, h: &mut H)`[src]

Feeds this value into the given `Hasher`. Read more

#### `pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,` 1.3.0[src]

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

### `impl Ord for PrefixComponent<'_>`[src]

#### `fn cmp(&self, other: &Self) -> Ordering`[src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]pub fn max(self, other: Self) -> Self` 1.21.0[src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]pub fn min(self, other: Self) -> Self` 1.21.0[src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self` 1.50.0[src]

Restrict a value to a certain interval. Read more

### `impl<'a> PartialEq<PrefixComponent<'a>> for PrefixComponent<'a>`[src]

#### `fn eq(&self, other: &PrefixComponent<'a>) -> bool`[src]

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

#### `#[must_use]pub fn ne(&self, other: &Rhs) -> bool`[src]

This method tests for `!=`.

### `impl<'a> PartialOrd<PrefixComponent<'a>> for PrefixComponent<'a>`[src]

#### `fn partial_cmp(&self, other: &PrefixComponent<'a>) -> Option<Ordering>`[src]

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

#### `#[must_use]pub fn lt(&self, other: &Rhs) -> bool`[src]

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

#### `#[must_use]pub fn le(&self, other: &Rhs) -> bool`[src]

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

#### `#[must_use]pub fn gt(&self, other: &Rhs) -> bool`[src]

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

#### `#[must_use]pub fn ge(&self, other: &Rhs) -> bool`[src]

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

### `impl<'a> StructuralEq for PrefixComponent<'a>`[src]

## Auto Trait Implementations

### `impl<'a> RefUnwindSafe for PrefixComponent<'a>`[src]

### `impl<'a> Send for PrefixComponent<'a>`[src]

### `impl<'a> Sync for PrefixComponent<'a>`[src]

### `impl<'a> Unpin for PrefixComponent<'a>`[src]

### `impl<'a> UnwindSafe for PrefixComponent<'a>`[src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W`
`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W`
`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `pub fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T`[src]

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

#### `pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

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

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.