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"));
Variants
Verbatim(&'a OsStr)
Verbatim prefix, e.g., \\?\cat_pics
.
Verbatim prefixes consist of \\?\
immediately followed by the given component.
Tuple Fields of Verbatim
0: &'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 :
.
Tuple Fields of VerbatimDisk
0: u8
DeviceNS(&'a OsStr)
Device namespace prefix, e.g., \\.\COM42
.
Device namespace prefixes consist of \\.\
immediately followed by the device name.
Tuple Fields of DeviceNS
0: &'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.
Tuple Fields of Disk
0: u8
Implementations
impl<'a> Prefix<'a>
pub 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());
Trait Implementations
impl<'a> Clone for Prefix<'a>
fn clone(&self) -> Prefix<'a>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl<'a> Debug for Prefix<'a>
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
impl<'a> Hash for Prefix<'a>
fn hash<__H: Hasher>(&self, state: &mut __H)
impl<'a> Ord for Prefix<'a>
fn cmp(&self, other: &Prefix<'a>) -> Ordering
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
fn clamp(self, min: Self, max: Self) -> Self
Restrict a value to a certain interval. Read more
impl<'a> PartialEq<Prefix<'a>> for Prefix<'a>
fn eq(&self, other: &Prefix<'a>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Prefix<'a>) -> bool
This method tests for !=
.
impl<'a> PartialOrd<Prefix<'a>> for Prefix<'a>
fn partial_cmp(&self, other: &Prefix<'a>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a> Copy for Prefix<'a>
impl<'a> Eq for Prefix<'a>
impl<'a> StructuralEq for Prefix<'a>
impl<'a> StructuralPartialEq for Prefix<'a>
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> From<T> for T
pub fn from(t: T) -> T
Performs the conversion.
pub fn into(self) -> U
Performs the conversion.
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
#41263)recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/path/enum.Prefix.html