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.

## Methods

###

`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<'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> 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> Eq for Component<'a>`

[src]

###

`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

####

`fn max(self, other: Self) -> Self`

1.21.0
[src]

Compares and returns the maximum of two values. Read more

####

`fn min(self, other: Self) -> Self`

1.21.0
[src]

Compares and returns the minimum of two values. Read more

###

`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> Hash for Component<'a>`

[src]

####

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

[src]

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

####

`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> Copy for Component<'a>`

[src]

###

`impl<'a> Clone for Component<'a>`

[src]

####

`fn clone(&self) -> Component<'a>`

[src]

Returns a copy of the value. Read more

####

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

[src]

Performs copy-assignment from `source`. Read more

###

`impl<'a> AsRef<OsStr> for Component<'a>`

[src]

####

`fn as_ref(&self) -> &OsStr`

[src]

Performs the conversion.

###

`impl<'a> AsRef<Path> for Component<'a>`

1.25.0
[src]

####

`fn as_ref(&self) -> &Path`

[src]

Performs the conversion.

## Auto Trait Implementations

###

`impl<'a> Send for Component<'a>`

###

`impl<'a> Sync for Component<'a>`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

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

###

`impl<T> ToOwned for T where T: Clone,`

[src]

#### `type Owned = T`

####

`fn to_owned(&self) -> T`

[src]

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

####

`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

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)