Struct netidx_core::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 root() -> Path

returns /

pub fn is_absolute<T: AsRef<str> + ?Sized>(p: &T) -> bool

returns true if the path starts with /, false otherwise

pub fn is_parent<T: AsRef<str> + ?Sized, U: AsRef<str> + ?Sized>(
    parent: &T,
    other: &U
) -> bool

true if this path is a parent to the specified path. A path is it’s own parent.

Examples

use netidx_core::path::Path;
assert!(Path::is_parent("/", "/foo/bar/baz"));
assert!(Path::is_parent("/foo/bar", "/foo/bar/baz"));
assert!(!Path::is_parent("/foo/bar", "/foo/bareth/bazeth"));
assert!(Path::is_parent("/foo/bar", "/foo/bar"));

pub fn lcp<'a, T: AsRef<str> + ?Sized, U: AsRef<str> + ?Sized>(
    path0: &'a T,
    path1: &'a U
) -> &'a str

finds the longest common parent of the two specified paths, / in the case they are completely disjoint.

pub fn escape<T: AsRef<str> + ?Sized>(s: &T) -> Cow<'_, str>

This will escape the path seperator and the escape character in a path part. If you want to be sure that e.g. append will only append 1 level, then you should call this function on your part before appending it.

Examples

use netidx_core::path::Path;
assert_eq!("foo\\/bar", &*Path::escape("foo/bar"));
assert_eq!("\\\\hello world", &*Path::escape("\\hello world"));

pub fn unescape<T: AsRef<str> + ?Sized>(s: &T) -> Cow<'_, str>

This will unescape the path seperator and the escape character in a path part.

Examples

use netidx_core::path::Path;
assert_eq!("foo/bar", &*Path::unescape("foo\\/bar"));
assert_eq!("\\hello world", &*Path::unescape("\\\\hello world"));

pub fn append<T: AsRef<str> + ?Sized>(&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_core::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<T: AsRef<str> + ?Sized>(s: &T) -> 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_core::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 dirnames<T: AsRef<str> + ?Sized>(s: &T) -> impl Iterator<Item = &str>

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

Examples

use netidx_core::path::Path;
let p = Path::from("/some/path/ending/in/foo");
let mut bn = Path::dirnames(&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<T: AsRef<str> + ?Sized>(s: &T) -> usize

Return the number of levels in the path.

Examples

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

pub fn dirname<T: AsRef<str> + ?Sized>(s: &T) -> Option<&str>

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

Examples

use netidx_core::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 dirname_with_sep<T: AsRef<str> + ?Sized>(s: &T) -> Option<&str>

pub fn basename<T: AsRef<str> + ?Sized>(s: &T) -> Option<&str>

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

Examples

use netidx_core::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<T: AsRef<str> + ?Sized>(s: &T) -> Option<usize>

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

Examples

use netidx_core::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<T: AsRef<str> + ?Sized>(s: &T) -> Option<usize>

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

Examples

use netidx_core::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<'de> Deserialize<'de> for Path

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Path

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

Formats the value using the given formatter.

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

fn from(s: ArcStr) -> 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.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl Pack for Path

fn encoded_len(&self) -> usize

fn encode(&self, buf: &mut impl BufMut) -> Result<(), PackError>

fn decode(buf: &mut impl Buf) -> Result<Self, PackError>

fn const_encoded_len() -> Option<usize>

fn decode_into(&mut self, buf: &mut impl Buf) -> Result<(), PackError> where
    Self: Sized, 

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: &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 Serialize for Path

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Path

impl StructuralEq for Path

impl StructuralPartialEq for Path