Enum typed_path::Utf8TypedPathBuf

pub enum Utf8TypedPathBuf {
    Unix(Utf8UnixPathBuf),
    Windows(Utf8WindowsPathBuf),
}

Represents a UTF-8 pathbuf with a known type that can be one of:

• Utf8UnixPathBuf
• Utf8WindowsPathBuf

Variants

Unix(Utf8UnixPathBuf)

Windows(Utf8WindowsPathBuf)

Implementations

impl Utf8TypedPathBuf

pub fn is_unix(&self) -> bool

Returns true if this path represents a Unix path.

pub fn is_windows(&self) -> bool

Returns true if this path represents a Windows path.

pub fn as_path(&self) -> Utf8TypedPath<'_>

Converts into a Utf8TypedPath.

Trait Implementations

impl<'a> From<&'a str> for Utf8TypedPathBuf

fn from(s: &'a str) -> Self

Creates a new UTF-8 typed pathbuf from a byte slice by determining if the path represents a Windows or Unix path. This is accomplished by first trying to parse as a Windows path. If the resulting path contains a prefix such as C: or begins with a \, it is assumed to be a Utf8WindowsPathBuf; otherwise, the slice will be represented as a Utf8UnixPathBuf.

Examples

use typed_path::Utf8TypedPathBuf;

assert!(Utf8TypedPathBuf::from(r#"C:\some\path\to\file.txt"#).is_windows());
assert!(Utf8TypedPathBuf::from(r#"\some\path\to\file.txt"#).is_windows());
assert!(Utf8TypedPathBuf::from(r#"/some/path/to/file.txt"#).is_unix());

// NOTE: If we don't start with a backslash, it's too difficult to
//       determine and we therefore just assume a Unix/POSIX path.
assert!(Utf8TypedPathBuf::from(r#"some\path\to\file.txt"#).is_unix());
assert!(Utf8TypedPathBuf::from("file.txt").is_unix());
assert!(Utf8TypedPathBuf::from("").is_unix());

impl From<String> for Utf8TypedPathBuf

fn from(s: String) -> Self

Converts to this type from the input type.

impl TryFrom<Utf8TypedPathBuf> for PathBuf

type Error = Utf8TypedPathBuf

The type returned in the event of a conversion error.

fn try_from(path: Utf8TypedPathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Utf8TypedPathBuf> for Utf8UnixPathBuf

type Error = Utf8TypedPathBuf

The type returned in the event of a conversion error.

fn try_from(path: Utf8TypedPathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Utf8TypedPathBuf> for Utf8WindowsPathBuf

type Error = Utf8TypedPathBuf

The type returned in the event of a conversion error.

fn try_from(path: Utf8TypedPathBuf) -> Result<Self, Self::Error>

Performs the conversion.