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

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

    pub enum Prefix<'a> {
        Verbatim(&'a OsStr),
        VerbatimUNC(&'a OsStr, &'a OsStr),
        VerbatimDisk(u8),
        DeviceNS(&'a OsStr),
        UNC(&'a OsStr, &'a OsStr),
        Disk(u8),
    }

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

Windows uses a variety of path prefix styles, including references to drive volumes (like `C:`), network shared folders (like `\\server\share`), and others. In addition, some path prefixes are "verbatim" (i.e. prefixed with `\\?\`), in which case `/` is not treated as a separator and essentially no normalization is performed.

# Examples

    use std::path::{Component, Path, Prefix};
    use std::path::Prefix::*;
    use std::ffi::OsStr;

    fn get_path_prefix(s: &str) -> Prefix {
        let path = Path::new(s);
        match path.components().next().unwrap() {
            Component::Prefix(prefix_component) => prefix_component.kind(),
            _ => panic!(),
        }
    }

    assert_eq!(Verbatim(OsStr::new("pictures")),
               get_path_prefix(r"\\?\pictures\kittens"));
    assert_eq!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")),
               get_path_prefix(r"\\?\UNC\server\share"));
    assert_eq!(VerbatimDisk(b'C'), get_path_prefix(r"\\?\c:\"));
    assert_eq!(DeviceNS(OsStr::new("BrainInterface")),
               get_path_prefix(r"\\.\BrainInterface"));
    assert_eq!(UNC(OsStr::new("server"), OsStr::new("share")),
               get_path_prefix(r"\\server\share"));
    assert_eq!(Disk(b'C'), get_path_prefix(r"C:\Users\Rust\Pictures\Ferris"));Run

## Variants

`Verbatim(&'a OsStr)`

Verbatim prefix, e.g. `\\?\cat_pics`.

Verbatim prefixes consist of `\\?\` immediately followed by the given component.

`VerbatimUNC(&'a OsStr, &'a OsStr)`

Verbatim prefix using Windows' Uniform Naming Convention, e.g. `\\?\UNC\server\share`.

Verbatim UNC prefixes consist of `\\?\UNC\` immediately followed by the server's hostname and a share name.

`VerbatimDisk(u8)`

Verbatim disk prefix, e.g. `\\?\C:\`.

Verbatim disk prefixes consist of `\\?\` immediately followed by the drive letter and `:\`.

`DeviceNS(&'a OsStr)`

Device namespace prefix, e.g. `\\.\COM42`.

Device namespace prefixes consist of `\\.\` immediately followed by the device name.

`UNC(&'a OsStr, &'a OsStr)`

Prefix using Windows' Uniform Naming Convention, e.g. `\\server\share`.

UNC prefixes consist of the server's hostname and a share name.

`Disk(u8)`

Prefix `C:` for the given disk drive.

## Methods

###

`impl<'a> Prefix<'a>`

[src]

####

`pub fn is_verbatim(&self) -> bool`

[src]

Determines if the prefix is verbatim, i.e. begins with `\\?\`.

# Examples

    use std::path::Prefix::*;
    use std::ffi::OsStr;

    assert!(Verbatim(OsStr::new("pictures")).is_verbatim());
    assert!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
    assert!(VerbatimDisk(b'C').is_verbatim());
    assert!(!DeviceNS(OsStr::new("BrainInterface")).is_verbatim());
    assert!(!UNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
    assert!(!Disk(b'C').is_verbatim());Run

## Trait Implementations

###

`impl<'a> PartialEq<Prefix<'a>> for Prefix<'a>`

[src]

####

`fn eq(&self, other: &Prefix<'a>) -> bool`

[src]

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

####

`fn ne(&self, other: &Prefix<'a>) -> bool`

[src]

This method tests for `!=`.

###

`impl<'a> Eq for Prefix<'a>`

[src]

###

`impl<'a> Ord for Prefix<'a>`

[src]

####

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

[src]

####

`fn partial_cmp(&self, other: &Prefix<'a>) -> Option<Ordering>`

[src]

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

####

`fn lt(&self, other: &Prefix<'a>) -> bool`

[src]

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

####

`fn le(&self, other: &Prefix<'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: &Prefix<'a>) -> bool`

[src]

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

####

`fn ge(&self, other: &Prefix<'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> Clone for Prefix<'a>`

[src]

####

`fn clone(&self) -> Prefix<'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> Copy for Prefix<'a>`

[src]

###

`impl<'a> Debug for Prefix<'a>`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

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

## Auto Trait Implementations

###

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

###

`impl<'a> Sync for Prefix<'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 &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ 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 &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ 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`)