Type Alias typed_path::unix::Utf8UnixPathBuf

pub type Utf8UnixPathBuf = Utf8PathBuf<Utf8UnixEncoding>;

Represents a Unix-specific Utf8PathBuf

Aliased Type

struct Utf8UnixPathBuf { /* private fields */ }

Implementations

impl<T> Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

pub fn new() -> Self

Allocates an empty Utf8PathBuf.

Examples

use typed_path::{Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let path = Utf8PathBuf::<Utf8UnixEncoding>::new();

pub fn with_capacity(capacity: usize) -> Self

Creates a new PathBuf with a given capacity used to create the internal String. See with_capacity defined on String.

Examples

use typed_path::{Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut path = Utf8PathBuf::<Utf8UnixEncoding>::with_capacity(10);
let capacity = path.capacity();

// This push is done without reallocating
path.push(r"C:\");

assert_eq!(capacity, path.capacity());

pub fn as_path(&self) -> &Utf8Path<T>

Coerces to a Utf8Path slice.

Examples

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let p = Utf8PathBuf::<Utf8UnixEncoding>::from("/test");
assert_eq!(Utf8Path::new("/test"), p.as_path());

pub fn push<P: AsRef<Utf8Path<T>>>(&mut self, path: P)

Extends self with path.

If path is absolute, it replaces the current path.

With Utf8WindowsPathBuf:

• if path has a root but no prefix (e.g., \windows), it replaces everything except for the prefix (if any) of self.
• if path has a prefix but no root, it replaces self.
• if self has a verbatim prefix (e.g. \\?\C:\windows) and path is not empty, the new path is normalized: all references to . and .. are removed.

Examples

Pushing a relative path extends the existing path:

use typed_path::{Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut path = Utf8PathBuf::<Utf8UnixEncoding>::from("/tmp");
path.push("file.bk");
assert_eq!(path, Utf8PathBuf::from("/tmp/file.bk"));

Pushing an absolute path replaces the existing path:

use typed_path::{Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut path = Utf8PathBuf::<Utf8UnixEncoding>::from("/tmp");
path.push("/etc");
assert_eq!(path, Utf8PathBuf::from("/etc"));

pub fn pop(&mut self) -> bool

Truncates self to self.parent.

Returns false and does nothing if self.parent is None. Otherwise, returns true.

Examples

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut p = Utf8PathBuf::<Utf8UnixEncoding>::from("/spirited/away.rs");

p.pop();
assert_eq!(Utf8Path::new("/spirited"), p);
p.pop();
assert_eq!(Utf8Path::new("/"), p);

pub fn set_file_name<S: AsRef<str>>(&mut self, file_name: S)

Updates self.file_name to file_name.

If self.file_name was None, this is equivalent to pushing file_name.

Otherwise it is equivalent to calling pop and then pushing file_name. The new path will be a sibling of the original path. (That is, it will have the same parent.)

Examples

use typed_path::{Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let mut buf = Utf8PathBuf::<Utf8UnixEncoding>::from("/");
assert!(buf.file_name() == None);
buf.set_file_name("bar");
assert!(buf == Utf8PathBuf::from("/bar"));
assert!(buf.file_name().is_some());
buf.set_file_name("baz.txt");
assert!(buf == Utf8PathBuf::from("/baz.txt"));

pub fn set_extension<S: AsRef<str>>(&mut self, extension: S) -> bool

Updates self.extension to extension.

Returns false and does nothing if self.file_name is None, returns true and updates the extension otherwise.

If self.extension is None, the extension is added; otherwise it is replaced.

Examples

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

let mut p = Utf8PathBuf::<Utf8UnixEncoding>::from("/feel/the");

p.set_extension("force");
assert_eq!(Utf8Path::new("/feel/the.force"), p.as_path());

p.set_extension("dark_side");
assert_eq!(Utf8Path::new("/feel/the.dark_side"), p.as_path());

pub fn into_string(self) -> String

Consumes the PathBuf, yielding its internal String storage.

Examples

use typed_path::{Utf8PathBuf, Utf8UnixEncoding};

let p = Utf8PathBuf::<Utf8UnixEncoding>::from("/the/head");
let s = p.into_string();

pub fn into_boxed_path(self) -> Box<Utf8Path<T>>

Converts this Utf8PathBuf into a boxed Utf8Path.

pub fn capacity(&self) -> usize

Invokes capacity on the underlying instance of String.

pub fn clear(&mut self)

Invokes clear on the underlying instance of String.

pub fn reserve(&mut self, additional: usize)

Invokes reserve on the underlying instance of String.

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

Invokes try_reserve on the underlying instance of String.

pub fn reserve_exact(&mut self, additional: usize)

Invokes reserve_exact on the underlying instance of String.

pub fn try_reserve_exact( &mut self, additional: usize ) -> Result<(), TryReserveError>

Invokes try_reserve_exact on the underlying instance of String.

pub fn shrink_to_fit(&mut self)

Invokes shrink_to_fit on the underlying instance of String.

pub fn shrink_to(&mut self, min_capacity: usize)

Invokes shrink_to on the underlying instance of String.

pub fn from_bytes_path_buf<U>( path_buf: PathBuf<U> ) -> Result<Self, FromUtf8Error>where U: for<'enc> Encoding<'enc>,

Consumes PathBuf and returns a new Utf8PathBuf by checking that the path contains valid UTF-8.

Errors

Returns Err if the path is not UTF-8 with a description as to why the provided component is not UTF-8.

Examples

use typed_path::{PathBuf, Utf8PathBuf, UnixEncoding, Utf8UnixEncoding};

let path_buf = PathBuf::<UnixEncoding>::from(&[0xf0, 0x9f, 0x92, 0x96]);
let utf8_path_buf = Utf8PathBuf::<Utf8UnixEncoding>::from_bytes_path_buf(path_buf).unwrap();
assert_eq!(utf8_path_buf.as_str(), "💖");

pub unsafe fn from_bytes_path_buf_unchecked<U>(path_buf: PathBuf<U>) -> Selfwhere U: for<'enc> Encoding<'enc>,

Consumes PathBuf and returns a new Utf8PathBuf by checking that the path contains valid UTF-8.

Errors

Returns Err if the path is not UTF-8 with a description as to why the provided component is not UTF-8.

Safety

The path passed in must be valid UTF-8.

Examples

use typed_path::{PathBuf, Utf8PathBuf, UnixEncoding, Utf8UnixEncoding};

let path_buf = PathBuf::<UnixEncoding>::from(&[0xf0, 0x9f, 0x92, 0x96]);
let utf8_path_buf = unsafe {
    Utf8PathBuf::<Utf8UnixEncoding>::from_bytes_path_buf_unchecked(path_buf)
};
assert_eq!(utf8_path_buf.as_str(), "💖");

pub fn into_bytes_path_buf<U>(self) -> PathBuf<U>where U: for<'enc> Encoding<'enc>,

Consumes Utf8PathBuf and returns a new PathBuf

Examples

use typed_path::{PathBuf, Utf8PathBuf, UnixEncoding, Utf8UnixEncoding};

let utf8_path_buf = Utf8PathBuf::<Utf8UnixEncoding>::from("💖");
let path_buf = utf8_path_buf.into_bytes_path_buf::<UnixEncoding>();
assert_eq!(path_buf.as_bytes(), &[0xf0, 0x9f, 0x92, 0x96]);

Methods from Deref<Target = Utf8Path<T>>

pub fn as_str(&self) -> &str

Yields the underlying str slice.

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let s = Utf8Path::<Utf8UnixEncoding>::new("foo.txt").as_str();
assert_eq!(s, "foo.txt");

pub fn to_path_buf(&self) -> Utf8PathBuf<T>

Converts a Utf8Path to an owned Utf8PathBuf.

Examples

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path_buf = Utf8Path::<Utf8UnixEncoding>::new("foo.txt").to_path_buf();
assert_eq!(path_buf, Utf8PathBuf::from("foo.txt"));

pub fn is_absolute(&self) -> bool

Returns true if the Utf8Path is absolute, i.e., if it is independent of the current directory.

• On Unix (Utf8UnixPath]), a path is absolute if it starts with the root, so is_absolute and has_root are equivalent.

• On Windows (Utf8WindowsPath), a path is absolute if it has a prefix and starts with the root: c:\windows is absolute, while c:temp and \temp are not.

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert!(!Utf8Path::<Utf8UnixEncoding>::new("foo.txt").is_absolute());

pub fn is_relative(&self) -> bool

Returns true if the Utf8Path is relative, i.e., not absolute.

See is_absolute’s documentation for more details.

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert!(Utf8Path::<Utf8UnixEncoding>::new("foo.txt").is_relative());

pub fn has_root(&self) -> bool

Returns true if the Utf8Path has a root.

• On Unix (Utf8UnixPath), a path has a root if it begins with /.

• On Windows (Utf8WindowsPath), a path has a root if it:

  • has no prefix and begins with a separator, e.g., \windows
  • has a prefix followed by a separator, e.g., c:\windows but not c:windows
  • has any non-disk prefix, e.g., \\server\share

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert!(Utf8Path::<Utf8UnixEncoding>::new("/etc/passwd").has_root());

pub fn parent(&self) -> Option<&Self>

Returns the Utf8Path without its final component, if there is one.

Returns None if the path terminates in a root or prefix.

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Utf8Path::<Utf8UnixEncoding>::new("/foo/bar");
let parent = path.parent().unwrap();
assert_eq!(parent, Utf8Path::new("/foo"));

let grand_parent = parent.parent().unwrap();
assert_eq!(grand_parent, Utf8Path::new("/"));
assert_eq!(grand_parent.parent(), None);

pub fn ancestors(&self) -> Utf8Ancestors<'_, T>

Produces an iterator over Utf8Path and its ancestors.

The iterator will yield the Utf8Path that is returned if the parent method is used zero or more times. That means, the iterator will yield &self, &self.parent().unwrap(), &self.parent().unwrap().parent().unwrap() and so on. If the parent method returns None, the iterator will do likewise. The iterator will always yield at least one value, namely &self.

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let mut ancestors = Utf8Path::<Utf8UnixEncoding>::new("/foo/bar").ancestors();
assert_eq!(ancestors.next(), Some(Utf8Path::new("/foo/bar")));
assert_eq!(ancestors.next(), Some(Utf8Path::new("/foo")));
assert_eq!(ancestors.next(), Some(Utf8Path::new("/")));
assert_eq!(ancestors.next(), None);

// NOTE: A path cannot be created on its own without a defined encoding
let mut ancestors = Utf8Path::<Utf8UnixEncoding>::new("../foo/bar").ancestors();
assert_eq!(ancestors.next(), Some(Utf8Path::new("../foo/bar")));
assert_eq!(ancestors.next(), Some(Utf8Path::new("../foo")));
assert_eq!(ancestors.next(), Some(Utf8Path::new("..")));
assert_eq!(ancestors.next(), Some(Utf8Path::new("")));
assert_eq!(ancestors.next(), None);

pub fn file_name(&self) -> Option<&str>

Returns the final component of the Utf8Path, if there is one.

If the path is a normal file, this is the file name. If it’s the path of a directory, this is the directory name.

Returns None if the path terminates in ...

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!(Some("bin"), Utf8Path::<Utf8UnixEncoding>::new("/usr/bin/").file_name());
assert_eq!(Some("foo.txt"), Utf8Path::<Utf8UnixEncoding>::new("tmp/foo.txt").file_name());
assert_eq!(Some("foo.txt"), Utf8Path::<Utf8UnixEncoding>::new("foo.txt/.").file_name());
assert_eq!(Some("foo.txt"), Utf8Path::<Utf8UnixEncoding>::new("foo.txt/.//").file_name());
assert_eq!(None, Utf8Path::<Utf8UnixEncoding>::new("foo.txt/..").file_name());
assert_eq!(None, Utf8Path::<Utf8UnixEncoding>::new("/").file_name());

pub fn strip_prefix<P>(&self, base: P) -> Result<&Utf8Path<T>, StripPrefixError>where P: AsRef<Utf8Path<T>>,

Returns a path that, when joined onto base, yields self.

Errors

If base is not a prefix of self (i.e., starts_with returns false), returns Err.

Examples

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Utf8Path::<Utf8UnixEncoding>::new("/test/haha/foo.txt");

assert_eq!(path.strip_prefix("/"), Ok(Utf8Path::new("test/haha/foo.txt")));
assert_eq!(path.strip_prefix("/test"), Ok(Utf8Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/"), Ok(Utf8Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Utf8Path::new("")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Utf8Path::new("")));

assert!(path.strip_prefix("test").is_err());
assert!(path.strip_prefix("/haha").is_err());

let prefix = Utf8PathBuf::<Utf8UnixEncoding>::from("/test/");
assert_eq!(path.strip_prefix(prefix), Ok(Utf8Path::new("haha/foo.txt")));

pub fn starts_with<P>(&self, base: P) -> boolwhere P: AsRef<Utf8Path<T>>,

Determines whether base is a prefix of self.

Only considers whole path components to match.

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Utf8Path::<Utf8UnixEncoding>::new("/etc/passwd");

assert!(path.starts_with("/etc"));
assert!(path.starts_with("/etc/"));
assert!(path.starts_with("/etc/passwd"));
assert!(path.starts_with("/etc/passwd/")); // extra slash is okay
assert!(path.starts_with("/etc/passwd///")); // multiple extra slashes are okay

assert!(!path.starts_with("/e"));
assert!(!path.starts_with("/etc/passwd.txt"));

assert!(!Utf8Path::<Utf8UnixEncoding>::new("/etc/foo.rs").starts_with("/etc/foo"));

pub fn ends_with<P>(&self, child: P) -> boolwhere P: AsRef<Utf8Path<T>>,

Determines whether child is a suffix of self.

Only considers whole path components to match.

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Utf8Path::<Utf8UnixEncoding>::new("/etc/resolv.conf");

assert!(path.ends_with("resolv.conf"));
assert!(path.ends_with("etc/resolv.conf"));
assert!(path.ends_with("/etc/resolv.conf"));

assert!(!path.ends_with("/resolv.conf"));
assert!(!path.ends_with("conf")); // use .extension() instead

pub fn file_stem(&self) -> Option<&str>

Extracts the stem (non-extension) portion of self.file_name.

The stem is:

• None, if there is no file name;
• The entire file name if there is no embedded .;
• The entire file name if the file name begins with . and has no other .s within;
• Otherwise, the portion of the file name before the final .

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!("foo", Utf8Path::<Utf8UnixEncoding>::new("foo.rs").file_stem().unwrap());
assert_eq!("foo.tar", Utf8Path::<Utf8UnixEncoding>::new("foo.tar.gz").file_stem().unwrap());

pub fn extension(&self) -> Option<&str>

Extracts the extension of self.file_name, if possible.

The extension is:

• None, if there is no file name;
• None, if there is no embedded .;
• None, if the file name begins with . and has no other .s within;
• Otherwise, the portion of the file name after the final .

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!("rs", Utf8Path::<Utf8UnixEncoding>::new("foo.rs").extension().unwrap());
assert_eq!("gz", Utf8Path::<Utf8UnixEncoding>::new("foo.tar.gz").extension().unwrap());

pub fn normalize(&self) -> Utf8PathBuf<T>

Returns an owned Utf8PathBuf by resolving .. and . segments.

When multiple, sequential path segment separation characters are found (e.g. / for Unix and either \ or / on Windows), they are replaced by a single instance of the platform-specific path segment separator (/ on Unix and \ on Windows).

Examples

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!(
    Utf8Path::<Utf8UnixEncoding>::new("foo/bar//baz/./asdf/quux/..").normalize(),
    Utf8PathBuf::from("foo/bar/baz/asdf"),
);

When starting with a root directory, any .. segment whose parent is the root directory will be filtered out:

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!(
    Utf8Path::<Utf8UnixEncoding>::new("/../foo").normalize(),
    Utf8PathBuf::from("/foo"),
);

If any .. is left unresolved as the path is relative and no parent is found, it is discarded:

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding, Utf8WindowsEncoding};

assert_eq!(
    Utf8Path::<Utf8UnixEncoding>::new("../foo/..").normalize(),
    Utf8PathBuf::from(""),
);

//Windows prefixes also count this way, but the prefix remains
assert_eq!(
    Utf8Path::<Utf8WindowsEncoding>::new(r"C:..\foo\..").normalize(),
    Utf8PathBuf::from(r"C:"),
);

pub fn absolutize(&self) -> Result<Utf8PathBuf<T>>

Converts a path to an absolute form by normalizing the path, returning a Utf8PathBuf.

In the case that the path is relative, the current working directory is prepended prior to normalizing.

Examples

use typed_path::{utils, Utf8Path, Utf8UnixEncoding};

// With an absolute path, it is just normalized
let path = Utf8Path::<Utf8UnixEncoding>::new("/a/b/../c/./d");
assert_eq!(path.absolutize().unwrap(), Utf8Path::new("/a/c/d"));

// With a relative path, it is first joined with the current working directory
// and then normalized
let cwd = utils::utf8_current_dir().unwrap().with_encoding::<Utf8UnixEncoding>();
let path = cwd.join(Utf8Path::new("a/b/../c/./d"));
assert_eq!(path.absolutize().unwrap(), cwd.join(Utf8Path::new("a/c/d")));

pub fn join<P: AsRef<Utf8Path<T>>>(&self, path: P) -> Utf8PathBuf<T>

Creates an owned Utf8PathBuf with path adjoined to self.

See Utf8PathBuf::push for more details on what it means to adjoin a path.

Examples

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
assert_eq!(
    Utf8Path::<Utf8UnixEncoding>::new("/etc").join("passwd"),
    Utf8PathBuf::from("/etc/passwd"),
);

pub fn with_file_name<S: AsRef<str>>(&self, file_name: S) -> Utf8PathBuf<T>

Creates an owned Utf8PathBuf like self but with the given file name.

See Utf8PathBuf::set_file_name for more details.

Examples

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Utf8Path::<Utf8UnixEncoding>::new("/tmp/foo.txt");
assert_eq!(path.with_file_name("bar.txt"), Utf8PathBuf::from("/tmp/bar.txt"));

// NOTE: A path cannot be created on its own without a defined encoding
let path = Utf8Path::<Utf8UnixEncoding>::new("/tmp");
assert_eq!(path.with_file_name("var"), Utf8PathBuf::from("/var"));

pub fn with_extension<S: AsRef<str>>(&self, extension: S) -> Utf8PathBuf<T>

Creates an owned Utf8PathBuf like self but with the given extension.

See Utf8PathBuf::set_extension for more details.

Examples

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let path = Utf8Path::<Utf8UnixEncoding>::new("foo.rs");
assert_eq!(path.with_extension("txt"), Utf8PathBuf::from("foo.txt"));

// NOTE: A path cannot be created on its own without a defined encoding
let path = Utf8Path::<Utf8UnixEncoding>::new("foo.tar.gz");
assert_eq!(path.with_extension(""), Utf8PathBuf::from("foo.tar"));
assert_eq!(path.with_extension("xz"), Utf8PathBuf::from("foo.tar.xz"));
assert_eq!(path.with_extension("").with_extension("txt"), Utf8PathBuf::from("foo.txt"));

pub fn components(&self) -> <T as Utf8Encoding<'_>>::Components

Produces an iterator over the Utf8Components of the path.

When parsing the path, there is a small amount of normalization:

• Repeated separators are ignored, so a/b and a//b both have a and b as components.

• Occurrences of . are normalized away, except if they are at the beginning of the path. For example, a/./b, a/b/, a/b/. and a/b all have a and b as components, but ./a/b starts with an additional CurDir component.

• A trailing slash is normalized away, /a/b and /a/b/ are equivalent.

Note that no other normalization takes place; in particular, a/c and a/b/../c are distinct, to account for the possibility that b is a symbolic link (so its parent isn’t a).

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding, unix::Utf8UnixComponent};

// NOTE: A path cannot be created on its own without a defined encoding
let mut components = Utf8Path::<Utf8UnixEncoding>::new("/tmp/foo.txt").components();

assert_eq!(components.next(), Some(Utf8UnixComponent::RootDir));
assert_eq!(components.next(), Some(Utf8UnixComponent::Normal("tmp")));
assert_eq!(components.next(), Some(Utf8UnixComponent::Normal("foo.txt")));
assert_eq!(components.next(), None)

Examples found in repository

examples/unix_utf8.rs (line 6)

fn main() {
    let path = Utf8UnixPath::new("/path/to/file.txt");

    for component in path.components() {
        println!("{}", component.as_str());
    }
}

examples/windows_utf8.rs (line 6)

fn main() {
    let path = Utf8WindowsPath::new(r"C:\path\to\file.txt");

    for component in path.components() {
        println!("{}", component.as_str());
    }
}

pub fn iter(&self) -> Utf8Iter<'_, T>

Produces an iterator over the path’s components viewed as str slices.

For more information about the particulars of how the path is separated into components, see components.

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding};

// NOTE: A path cannot be created on its own without a defined encoding
let mut it = Utf8Path::<Utf8UnixEncoding>::new("/tmp/foo.txt").iter();

assert_eq!(it.next(), Some(typed_path::unix::SEPARATOR_STR));
assert_eq!(it.next(), Some("tmp"));
assert_eq!(it.next(), Some("foo.txt"));
assert_eq!(it.next(), None)

pub fn with_encoding<U>(&self) -> Utf8PathBuf<U>where U: for<'enc> Utf8Encoding<'enc>,

Creates an owned Utf8PathBuf like self but with a different encoding.

Note

As part of the process of converting between encodings, the path will need to be rebuilt. This involves pushing each component, which may result in differences in the resulting path such as resolving . and .. early or other unexpected side effects.

Examples

use typed_path::{Utf8Path, Utf8UnixEncoding, Utf8WindowsEncoding};

// Convert from Unix to Windows
let unix_path = Utf8Path::<Utf8UnixEncoding>::new("/tmp/foo.txt");
let windows_path = unix_path.with_encoding::<Utf8WindowsEncoding>();
assert_eq!(windows_path, Utf8Path::<Utf8WindowsEncoding>::new(r"\tmp\foo.txt"));

// Converting from Windows to Unix will drop any prefix
let windows_path = Utf8Path::<Utf8WindowsEncoding>::new(r"C:\tmp\foo.txt");
let unix_path = windows_path.with_encoding::<Utf8UnixEncoding>();
assert_eq!(unix_path, Utf8Path::<Utf8UnixEncoding>::new(r"/tmp/foo.txt"));

// Converting to itself should retain everything
let path = Utf8Path::<Utf8WindowsEncoding>::new(r"C:\tmp\foo.txt");
assert_eq!(
    path.with_encoding::<Utf8WindowsEncoding>(),
    Utf8Path::<Utf8WindowsEncoding>::new(r"C:\tmp\foo.txt"),
);

pub fn as_bytes_path<U>(&self) -> &Path<U>where U: for<'enc> Encoding<'enc>,

Converts a UTF-8 Utf8Path to a non-UTF-8 Path.

Examples

use typed_path::{Path, Utf8Path, UnixEncoding, Utf8UnixEncoding};

let utf8_path = Utf8Path::<Utf8UnixEncoding>::new("💖");
let path = utf8_path.as_bytes_path::<UnixEncoding>();
assert_eq!(path.as_bytes(), &[0xf0, 0x9f, 0x92, 0x96]);

pub fn has_unix_encoding(&self) -> bool

Returns true if the encoding for the path is for Unix.

Examples

use typed_path::{Utf8UnixPath, Utf8WindowsPath};

assert!(Utf8UnixPath::new("/some/path").has_unix_encoding());
assert!(!Utf8WindowsPath::new(r"\some\path").has_unix_encoding());

pub fn with_unix_encoding(&self) -> Utf8PathBuf<Utf8UnixEncoding>

Creates an owned Utf8PathBuf like self but using Utf8UnixEncoding.

See Utf8Path::with_encoding for more information.

pub fn has_windows_encoding(&self) -> bool

Returns true if the encoding for the path is for Windows.

Examples

use typed_path::{Utf8UnixPath, Utf8WindowsPath};

assert!(!Utf8UnixPath::new("/some/path").has_windows_encoding());
assert!(Utf8WindowsPath::new(r"\some\path").has_windows_encoding());

pub fn with_windows_encoding(&self) -> Utf8PathBuf<Utf8WindowsEncoding>

Creates an owned Utf8PathBuf like self but using Utf8WindowsEncoding.

See Utf8Path::with_encoding for more information.

pub fn as_path(&self) -> &Utf8Path<T>

Coerces to a Utf8Path slice.

Examples

use typed_path::{Utf8Path, Utf8PathBuf, Utf8UnixEncoding};

// NOTE: A pathbuf cannot be created on its own without a defined encoding
let p = Utf8PathBuf::<Utf8UnixEncoding>::from("/test");
assert_eq!(Utf8Path::new("/test"), p.as_path());

pub fn capacity(&self) -> usize

Invokes capacity on the underlying instance of String.

Trait Implementations

impl<T> AsRef<[u8]> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> AsRef<Utf8Path<T>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn as_ref(&self) -> &Utf8Path<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> AsRef<str> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Borrow<Utf8Path<T>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn borrow(&self) -> &Utf8Path<T>

Immutably borrows from an owned value.

impl<T> Clone for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

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

Formats the value using the given formatter.

impl<T> Default for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn default() -> Utf8PathBuf<T>

Returns the “default value” for a type.

impl<T> Deref for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

type Target = Utf8Path<T>

The resulting type after dereferencing.

fn deref(&self) -> &Utf8Path<T>

Dereferences the value.

impl<T> Display for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

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

Formats the value using the given formatter.

impl<T, P> Extend<P> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>, P: AsRef<Utf8Path<T>>,

fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T, V> From<&V> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>, V: ?Sized + AsRef<str>,

fn from(s: &V) -> Self

Converts a borrowed str to a Utf8PathBuf.

Allocates a Utf8PathBuf and copies the data into it.

impl<T> From<Box<Utf8Path<T>, Global>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn from(boxed: Box<Utf8Path<T>>) -> Self

Converts to this type from the input type.

impl<'a, T> From<Cow<'a, Utf8Path<T>>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn from(p: Cow<'a, Utf8Path<T>>) -> Self

Converts a clone-on-write pointer to an owned path.

Converting from a Cow::Owned does not clone or allocate.

impl<T> From<String> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn from(inner: String) -> Self

Converts a String into a Utf8PathBuf

This conversion does not allocate or copy memory.

impl<T, P> FromIterator<P> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>, P: AsRef<Utf8Path<T>>,

fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> FromStr for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T> Hash for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a, T> PartialEq<&'a Utf8Path<T>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn eq(&self, other: &&'a Utf8Path<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T> PartialEq<&'a str> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn eq(&self, other: &&'a str) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T> PartialEq<Cow<'a, Utf8Path<T>>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn eq(&self, other: &Cow<'a, Utf8Path<T>>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T> PartialEq<Cow<'a, str>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn eq(&self, other: &Cow<'a, str>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialEq<String> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialEq<Utf8Path<T>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn eq(&self, other: &Utf8Path<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialEq<Utf8PathBuf<T>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialEq<str> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T> PartialOrd<&'a Utf8Path<T>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn partial_cmp(&self, other: &&'a Utf8Path<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, T> PartialOrd<&'a str> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn partial_cmp(&self, other: &&'a str) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, T> PartialOrd<Cow<'a, Utf8Path<T>>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn partial_cmp(&self, other: &Cow<'a, Utf8Path<T>>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, T> PartialOrd<Cow<'a, str>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

fn partial_cmp(&self, other: &Cow<'a, str>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> PartialOrd<String> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

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

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> PartialOrd<Utf8Path<T>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

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

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> PartialOrd<Utf8PathBuf<T>> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

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

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> PartialOrd<str> for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,

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

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Eq for Utf8PathBuf<T>where T: for<'enc> Utf8Encoding<'enc>,