Struct netidx::path::Path

pub struct Path(_);

A path in the namespace. Paths are immutable and reference counted. Path components are seperated by /, which may be escaped with . / and \ are the only special characters in path, any other unicode character may be used. Path lengths are not limited on the local machine, but may be restricted by maximum message size on the wire.

Implementations

impl Path

pub fn as_chars(self) -> Chars

pub fn root() -> Path

returns /

pub fn is_absolute<T: AsRef<str>>(p: T) -> bool

returns true if the path starts with /, false otherwise

pub fn append<T: AsRef<str>>(&self, other: T) -> Self

return a new path with the specified string appended as a new part separated by the pathsep char.

Examples

use netidx::path::Path;
let p = Path::root().append("bar").append("baz");
assert_eq!(&*p, "/bar/baz");

let p = Path::root().append("/bar").append("//baz//////foo/");
assert_eq!(&*p, "/bar/baz/foo");

pub fn parts(s: &str) -> impl Iterator<Item = &str>

return an iterator over the parts of the path. The path separator may be escaped with . and a literal \ may be represented as \.

Examples

use netidx::path::Path;
let p = Path::from("/foo/bar/baz");
assert_eq!(Path::parts(&p).collect::<Vec<_>>(), vec!["foo", "bar", "baz"]);

let p = Path::from(r"/foo\/bar/baz");
assert_eq!(Path::parts(&p).collect::<Vec<_>>(), vec![r"foo\/bar", "baz"]);

let p = Path::from(r"/foo\\/bar/baz");
assert_eq!(Path::parts(&p).collect::<Vec<_>>(), vec![r"foo\\", "bar", "baz"]);

let p = Path::from(r"/foo\\\/bar/baz");
assert_eq!(Path::parts(&p).collect::<Vec<_>>(), vec![r"foo\\\/bar", "baz"]);

pub fn basenames(s: &str) -> impl Iterator<Item = &str>

Return an iterator over all the basenames in the path starting from the root and ending with the entire path.

Examples

use netidx::path::Path;
let p = Path::from("/some/path/ending/in/foo");
let mut bn = Path::basenames(&p);
assert_eq!(bn.next(), Some("/"));
assert_eq!(bn.next(), Some("/some"));
assert_eq!(bn.next(), Some("/some/path"));
assert_eq!(bn.next(), Some("/some/path/ending"));
assert_eq!(bn.next(), Some("/some/path/ending/in"));
assert_eq!(bn.next(), Some("/some/path/ending/in/foo"));
assert_eq!(bn.next(), None);

pub fn levels(s: &str) -> usize

Return the number of levels in the path.

Examples

use netidx::path::Path;
let p = Path::from("/foo/bar/baz");
assert_eq!(Path::levels(&p), 3);

pub fn dirname(s: &str) -> Option<&str>

return the path without the last part, or return None if the path is empty or /.

Examples

use netidx::path::Path;
let p = Path::from("/foo/bar/baz");
assert_eq!(Path::dirname(&p), Some("/foo/bar"));

let p = Path::root();
assert_eq!(Path::dirname(&p), None);

let p = Path::from("/foo");
assert_eq!(Path::dirname(&p), None);

pub fn basename(s: &str) -> Option<&str>

return the last part of the path, or return None if the path is empty.

Examples

use netidx::path::Path;
let p = Path::from("/foo/bar/baz");
assert_eq!(Path::basename(&p), Some("baz"));

let p = Path::from("foo");
assert_eq!(Path::basename(&p), Some("foo"));

let p = Path::from("foo/bar");
assert_eq!(Path::basename(&p), Some("bar"));

let p = Path::from("");
assert_eq!(Path::basename(&p), None);

let p = Path::from("/");
assert_eq!(Path::basename(&p), None);

pub fn rfind_sep(s: &str) -> Option<usize>

return the position of the last path separator in the path, or None if there isn't one.

Examples

use netidx::path::Path;
let p = Path::from("/foo/bar/baz");
assert_eq!(Path::rfind_sep(&p), Some(8));

let p = Path::from("");
assert_eq!(Path::rfind_sep(&p), None);

pub fn find_sep(s: &str) -> Option<usize>

return the position of the first path separator in the path, or None if there isn't one.

Examples

use netidx::path::Path;
let p = Path::from("foo/bar/baz");
assert_eq!(Path::find_sep(&p), Some(3));

let p = Path::from("");
assert_eq!(Path::find_sep(&p), None);

Trait Implementations

impl AsRef<str> for Path

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<str> for Path

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Deref for Path

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Path

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

Formats the value using the given formatter.

impl Eq for Path

impl<'a> From<&'a String> for Path

fn from(s: &String) -> Path

Performs the conversion.

impl From<&'static str> for Path

fn from(s: &'static str) -> Path

Performs the conversion.

impl From<Chars> for Path

fn from(c: Chars) -> Path

Performs the conversion.

impl From<String> for Path

fn from(s: String) -> Path

Performs the conversion.

impl FromStr for Path

type Err = Error

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 Hash for Path

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Ord for Path

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Path> for Path

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

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

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

This method tests for !=.

impl PartialOrd<Path> for Path

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Path

impl StructuralPartialEq for Path