Enum camino::Utf8Prefix
source · pub enum Utf8Prefix<'a> {
Verbatim(&'a str),
VerbatimUNC(&'a str, &'a str),
VerbatimDisk(u8),
DeviceNS(&'a str),
UNC(&'a str, &'a str),
Disk(u8),
}
Expand description
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 camino::{Utf8Component, Utf8Path, Utf8Prefix};
use camino::Utf8Prefix::*;
fn get_path_prefix(s: &str) -> Utf8Prefix {
let path = Utf8Path::new(s);
match path.components().next().unwrap() {
Utf8Component::Prefix(prefix_component) => prefix_component.kind(),
_ => panic!(),
}
}
assert_eq!(Verbatim("pictures"), get_path_prefix(r"\\?\pictures\kittens"));
assert_eq!(VerbatimUNC("server", "share"), get_path_prefix(r"\\?\UNC\server\share"));
assert_eq!(VerbatimDisk(b'C'), get_path_prefix(r"\\?\c:\"));
assert_eq!(DeviceNS("BrainInterface"), get_path_prefix(r"\\.\BrainInterface"));
assert_eq!(UNC("server", "share"), get_path_prefix(r"\\server\share"));
assert_eq!(Disk(b'C'), get_path_prefix(r"C:\Users\Rust\Pictures\Ferris"));
Variants§
Verbatim(&'a str)
Verbatim prefix, e.g., \\?\cat_pics
.
Verbatim prefixes consist of \\?\
immediately followed by the given
component.
VerbatimUNC(&'a str, &'a str)
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 str)
Device namespace prefix, e.g., \\.\COM42
.
Device namespace prefixes consist of \\.\
immediately followed by the
device name.
UNC(&'a str, &'a str)
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§
source§impl<'a> Utf8Prefix<'a>
impl<'a> Utf8Prefix<'a>
sourcepub fn is_verbatim(&self) -> bool
pub fn is_verbatim(&self) -> bool
Determines if the prefix is verbatim, i.e., begins with \\?\
.
§Examples
use camino::Utf8Prefix::*;
assert!(Verbatim("pictures").is_verbatim());
assert!(VerbatimUNC("server", "share").is_verbatim());
assert!(VerbatimDisk(b'C').is_verbatim());
assert!(!DeviceNS("BrainInterface").is_verbatim());
assert!(!UNC("server", "share").is_verbatim());
assert!(!Disk(b'C').is_verbatim());
Trait Implementations§
source§impl<'a> Clone for Utf8Prefix<'a>
impl<'a> Clone for Utf8Prefix<'a>
source§fn clone(&self) -> Utf8Prefix<'a>
fn clone(&self) -> Utf8Prefix<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'a> Debug for Utf8Prefix<'a>
impl<'a> Debug for Utf8Prefix<'a>
source§impl<'a> Hash for Utf8Prefix<'a>
impl<'a> Hash for Utf8Prefix<'a>
source§impl<'a> Ord for Utf8Prefix<'a>
impl<'a> Ord for Utf8Prefix<'a>
source§fn cmp(&self, other: &Utf8Prefix<'a>) -> Ordering
fn cmp(&self, other: &Utf8Prefix<'a>) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl<'a> PartialEq for Utf8Prefix<'a>
impl<'a> PartialEq for Utf8Prefix<'a>
source§fn eq(&self, other: &Utf8Prefix<'a>) -> bool
fn eq(&self, other: &Utf8Prefix<'a>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<'a> PartialOrd for Utf8Prefix<'a>
impl<'a> PartialOrd for Utf8Prefix<'a>
source§fn partial_cmp(&self, other: &Utf8Prefix<'a>) -> Option<Ordering>
fn partial_cmp(&self, other: &Utf8Prefix<'a>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl<'a> Copy for Utf8Prefix<'a>
impl<'a> Eq for Utf8Prefix<'a>
impl<'a> StructuralPartialEq for Utf8Prefix<'a>
Auto Trait Implementations§
impl<'a> Freeze for Utf8Prefix<'a>
impl<'a> RefUnwindSafe for Utf8Prefix<'a>
impl<'a> Send for Utf8Prefix<'a>
impl<'a> Sync for Utf8Prefix<'a>
impl<'a> Unpin for Utf8Prefix<'a>
impl<'a> UnwindSafe for Utf8Prefix<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)