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

# 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

## Methods

###

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

[src]

###

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

[src]

####

`fn clone(&self) -> PrefixComponent<'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> Eq 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> PartialEq 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] fn ne(&self, other: &Rhs) -> bool`

[src]

This method tests for `!=`.

###

`impl<'a> PartialOrd 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] 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] 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] 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] 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> Ord for PrefixComponent<'a>`

[src]

####

`fn cmp(&self, other: &PrefixComponent<'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> Hash for PrefixComponent<'a>`

[src]

####

`fn hash<H: Hasher>(&self, h: &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

## Auto Trait Implementations

###

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

###

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

# 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`)