Enum std::path::Prefix

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

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.


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!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")),
assert_eq!(VerbatimDisk(b'C'), get_path_prefix(r"\\?\c:\"));
assert_eq!(UNC(OsStr::new("server"), OsStr::new("share")),
assert_eq!(Disk(b'C'), get_path_prefix(r"C:\Users\Rust\Pictures\Ferris"));


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.


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.


Prefix C: for the given disk drive.


impl<'a> Prefix<'a>[src]

pub fn is_verbatim(&self) -> bool[src]

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


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

assert!(VerbatimUNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());
assert!(!UNC(OsStr::new("server"), OsStr::new("share")).is_verbatim());

Trait Implementations

impl<'a> Clone for Prefix<'a>[src]

impl<'a> Copy for Prefix<'a>[src]

impl<'a> Debug for Prefix<'a>[src]

impl<'a> Eq for Prefix<'a>[src]

impl<'a> Hash for Prefix<'a>[src]

impl<'a> Ord for Prefix<'a>[src]

impl<'a> PartialEq<Prefix<'a>> for Prefix<'a>[src]

impl<'a> PartialOrd<Prefix<'a>> for Prefix<'a>[src]

impl<'a> StructuralEq for Prefix<'a>[src]

impl<'a> StructuralPartialEq for Prefix<'a>[src]

Auto Trait Implementations

impl<'a> RefUnwindSafe for Prefix<'a>

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

impl<'a> Sync for Prefix<'a>

impl<'a> Unpin for Prefix<'a>

impl<'a> UnwindSafe for Prefix<'a>

Blanket Implementations

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

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

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

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

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

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.