Enum Prefix

pub enum Prefix<'a>

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!(),
    }
}

# if cfg!(windows) {
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"));
# }

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 \\.\ (possibly using / instead 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.

Implementations

impl<'a> Prefix<'a>

fn len(&self) -> usize
fn is_verbatim(&self) -> bool

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());

fn is_drive(&self) -> bool
fn has_implicit_root(&self) -> bool

Trait Implementations

impl<'a> Clone for Prefix<'a>

fn clone(&self) -> Self

impl<'a> Copy for Prefix<'a>

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

fn fmt(&self, f: &mut Formatter<'_>) -> Result

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

fn assert_fields_are_eq(&self)

impl<'a> Hash for Prefix<'a>

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

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

fn cmp(&self, other: &Self) -> Ordering

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

fn eq(&self, other: &Self) -> bool

impl<'a> PartialOrd for Prefix<'a>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

impl<'a> StructuralPartialEq for Prefix<'a>

impl<'a> TrivialClone for Prefix<'a>

Auto Trait Implementations

impl<'a> Freeze for Prefix<'a>

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> UnsafeUnpin for Prefix<'a>

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Prefix<'a> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Prefix<'a> where T: ?Sized,

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

impl<T> CloneToUninit for Prefix<'a> where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for Prefix<'a>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Printable for Prefix<'a> where T: Copy + Debug,

impl<T> SizeHint for Prefix<'a> where T: ?Sized,

fn lower_bound(&self) -> usize
fn upper_bound(&self) -> Option<usize>

impl<T> SizedTypeProperties for Prefix<'a>

impl<T> ToOwned for Prefix<'a> where T: Clone,

type Owned = T;
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

impl<T, U> Into<U> for Prefix<'a> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for Prefix<'a> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for Prefix<'a> where U: TryFrom<T>,

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