pub enum Utf8WindowsPrefix<'a> {
Verbatim(&'a str),
VerbatimUNC(&'a str, &'a str),
VerbatimDisk(char),
DeviceNS(&'a str),
UNC(&'a str, &'a str),
Disk(char),
}
Expand description
Windows path prefixes, e.g., C:
or \\server\share
. This is a byte slice version of
std::path::Prefix
.
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 typed_path::{Utf8WindowsPath, Utf8WindowsComponent, Utf8WindowsPrefix};
use typed_path::Utf8WindowsPrefix::*;
fn get_path_prefix(s: &str) -> Utf8WindowsPrefix {
let path = Utf8WindowsPath::new(s);
match path.components().next().unwrap() {
Utf8WindowsComponent::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('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('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(char)
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 \\.\
(possibly using /
instead 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(char)
Prefix C:
for the given disk drive.
Implementations§
Source§impl<'a> Utf8WindowsPrefix<'a>
impl<'a> Utf8WindowsPrefix<'a>
Sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Calculates the full byte length of the prefix
§Examples
use typed_path::Utf8WindowsPrefix::*;
// \\?\pictures -> 12 bytes
assert_eq!(Verbatim("pictures").len(), 12);
// \\?\UNC\server -> 14 bytes
assert_eq!(VerbatimUNC("server", "").len(), 14);
// \\?\UNC\server\share -> 20 bytes
assert_eq!(VerbatimUNC("server", "share").len(), 20);
// \\?\c: -> 6 bytes
assert_eq!(VerbatimDisk('C').len(), 6);
// \\.\BrainInterface -> 18 bytes
assert_eq!(DeviceNS("BrainInterface").len(), 18);
// \\server\share -> 14 bytes
assert_eq!(UNC("server", "share").len(), 14);
// C: -> 2 bytes
assert_eq!(Disk('C').len(), 2);
Sourcepub fn is_verbatim(&self) -> bool
pub fn is_verbatim(&self) -> bool
Determines if the prefix is verbatim, i.e., begins with \\?\
.
§Examples
use typed_path::Utf8WindowsPrefix::*;
assert!(Verbatim("pictures").is_verbatim());
assert!(VerbatimUNC("server", "share").is_verbatim());
assert!(VerbatimDisk('C').is_verbatim());
assert!(!DeviceNS("BrainInterface").is_verbatim());
assert!(!UNC("server", "share").is_verbatim());
assert!(!Disk('C').is_verbatim());
Sourcepub fn from_utf8(prefix: &WindowsPrefix<'a>) -> Result<Self, Utf8Error>
pub fn from_utf8(prefix: &WindowsPrefix<'a>) -> Result<Self, Utf8Error>
Converts a non-UTF-8 WindowsPrefix
to a UTF-8 Utf8WindowsPrefix
by checking that the prefix contains valid UTF-8.
§Errors
Returns Err
if the prefix component is not UTF-8 with a description as to why the
provided prefix is not UTF-8.
See the docs for Utf8Error
for more details on the kinds of
errors that can be returned.
Sourcepub unsafe fn from_utf8_unchecked(prefix: &WindowsPrefix<'a>) -> Self
pub unsafe fn from_utf8_unchecked(prefix: &WindowsPrefix<'a>) -> Self
Converts a non-UTF-8 WindowsPrefix
to a UTF-8 Utf8WindowsPrefix
without checking
that the string contains valid UTF-8.
See the safe version, from_utf8
, for more information.
§Safety
The prefix passed in must be valid UTF-8.
Trait Implementations§
Source§impl<'a> Clone for Utf8WindowsPrefix<'a>
impl<'a> Clone for Utf8WindowsPrefix<'a>
Source§fn clone(&self) -> Utf8WindowsPrefix<'a>
fn clone(&self) -> Utf8WindowsPrefix<'a>
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read more