std::path::Component - Rust
Description: API documentation for the Rust `Component` enum in crate `std`.
Keywords: rust, rustlang, rust-lang, Component

# 1.0.0[−][src]Enum std::path::Component

    pub enum Component<'a> {
        Prefix(PrefixComponent<'a>),
        RootDir,
        CurDir,
        ParentDir,
        Normal(&'a OsStr),
    }

A single component of a path.

A `Component` roughly corresponds to a substring between path separators (`/` or `\`).

This `enum` is created by iterating over `Components`, which in turn is created by the `components` method on `Path`.

# Examples

    use std::path::{Component, Path};

    let path = Path::new("/tmp/foo/bar.txt");
    let components = path.components().collect::<Vec<_>>();
    assert_eq!(&components, &[
        Component::RootDir,
        Component::Normal("tmp".as_ref()),
        Component::Normal("foo".as_ref()),
        Component::Normal("bar.txt".as_ref()),
    ]);

Run

## Variants

`Prefix(PrefixComponent<'a>)`

A Windows path prefix, e.g., `C:` or `\\server\share`.

There is a large variety of prefix types, see `Prefix`'s documentation for more.

Does not occur on Unix.

`RootDir`

The root directory component, appears after any prefix and before anything else.

It represents a separator that designates that a path starts from root.

`CurDir`

A reference to the current directory, i.e., `.`.

`ParentDir`

A reference to the parent directory, i.e., `..`.

`Normal(&'a OsStr)`

A normal component, e.g., `a` and `b` in `a/b`.

This variant is the most common one, it represents references to files or directories.

## Implementations

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

#### `pub fn as_os_str(self) -> &'a OsStr`[src]

Extracts the underlying `OsStr` slice.

# Examples

    use std::path::Path;

    let path = Path::new("./tmp/foo/bar.txt");
    let components: Vec<_> = path.components().map(|comp| comp.as_os_str()).collect();
    assert_eq!(&components, &[".", "tmp", "foo", "bar.txt"]);

Run

## Trait Implementations

### `impl AsRef<OsStr> for Component<'_>`[src]

#### `fn as_ref(&self) -> &OsStr`[src]

Performs the conversion.

### `impl AsRef<Path> for Component<'_>`1.25.0[src]

#### `fn as_ref(&self) -> &Path`[src]

Performs the conversion.

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

#### `fn clone(&self) -> Component<'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 Component<'a>`[src]

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

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

Formats the value using the given formatter. Read more

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

### `impl<'a> Hash for Component<'a>`[src]

#### `fn hash<__H: Hasher>(&self, state: &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<'a> Ord for Component<'a>`[src]

#### `fn cmp(&self, other: &Component<'a>) -> 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<Component<'a>> for Component<'a>`[src]

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

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

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

This method tests for `!=`.

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

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

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

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

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

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

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

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

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

#### `fn ge(&self, other: &Component<'a>) -> 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 Component<'a>`[src]

### `impl<'a> StructuralPartialEq for Component<'a>`[src]

## Auto Trait Implementations

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

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

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

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

### `impl<'a> UnwindSafe for Component<'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 I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;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 I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;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.