Struct radicle_surf::file_system::Path

pub struct Path(pub NonEmpty<Label>);

A non-empty set of Labels to define a path to a directory or file.

Path tends to be used for insertion or find operations.

Implementations

impl Path

pub fn new(label: Label) -> Path

Create a new Path with a single Label.

pub fn root() -> Self

The root path is a Path made up of the single root label (see: Label::root.

Examples

use radicle_surf::file_system::{Label, Path};

let root = Path::root();
assert_eq!(*root.split_first().0, Label::root());

pub fn is_root(&self) -> bool

Check that this is the root path.

Examples

use radicle_surf::file_system::Path;
use radicle_surf::file_system::unsound;
use std::convert::TryFrom;

let root = Path::root();
let not_root = unsound::path::new("src/lib.rs");

assert!(root.is_root());
assert!(!not_root.is_root());

pub fn append(&mut self, path: Self)

Append two Paths together.

Examples

use radicle_surf::file_system::Path;
use radicle_surf::file_system::unsound;
use std::convert::TryFrom;

let mut path1 = unsound::path::new("foo/bar");
let path2 = unsound::path::new("baz/quux");
path1.append(path2);
let expected = unsound::path::new("foo/bar/baz/quux");
assert_eq!(path1, expected);

pub fn push(&mut self, label: Label)

Push a new Label onto the Path.

Examples

use radicle_surf::file_system::{Label, Path};
use radicle_surf::file_system::unsound;

let mut root = Path::root();
root.push(unsound::label::new("src"));
root.push(unsound::label::new("lib.rs"));

assert_eq!(root, unsound::path::new("~/src/lib.rs"));

pub fn pop(&mut self) -> Option<Label>

Pop the Label from the end of the tail.

Examples

use radicle_surf::file_system::{Label, Path};
use radicle_surf::file_system::unsound;

let mut root = Path::root();
root.push(unsound::label::new("src"));
root.push(unsound::label::new("lib.rs"));

assert_eq!(root.pop(), Some(unsound::label::new("lib.rs")));

pub fn iter(&self) -> impl Iterator<Item = &Label>

Iterator over the Labels in the Path.

Examples

use radicle_surf::file_system::{Label, Path};
use radicle_surf::file_system::unsound;

let path = unsound::path::new("~/src/lib.rs");
let mut path_iter = path.iter();

assert_eq!(path_iter.next(), Some(&Label::root()));
assert_eq!(path_iter.next(), Some(&unsound::label::new("src")));
assert_eq!(path_iter.next(), Some(&unsound::label::new("lib.rs")));

pub fn split_first(&self) -> (&Label, &[Label])

Get the first Label in the Path and the rest of the Labels after it.

Examples

use radicle_surf::file_system::{Label, Path};
use radicle_surf::file_system::unsound;

let path = unsound::path::new("~/src/lib.rs");

assert_eq!(
    path.split_first(),
    (&Label::root(), &[unsound::label::new("src"), unsound::label::new("lib.rs")][..])
);

pub fn split_last(self) -> (Vec<Label>, Label)

Get the prefix of the Labels and the last Label.

This is useful when the prefix is a directory path and the last label is a file name.

Examples

use radicle_surf::file_system::{Label, Path};
use radicle_surf::file_system::unsound;

let path = unsound::path::new("~/src/lib.rs");
assert_eq!(path.split_last(), (vec![Label::root(), unsound::label::new("src")], unsound::label::new("lib.rs")));

use radicle_surf::file_system::{Label, Path};
use radicle_surf::file_system::unsound;

let path = unsound::path::new("foo/bar/baz");
assert_eq!(
    path.split_last(),
    (vec![unsound::label::new("foo"), unsound::label::new("bar")], unsound::label::new("baz"))
);

pub fn from_labels(root: Label, labels: &[Label]) -> Path

Construct a Path given at least one Label followed by 0 or more Labels.

Examples

use nonempty::NonEmpty;
use radicle_surf::file_system::{Path, Label};
use radicle_surf::file_system::unsound;

let path = Path::from_labels(
    Label::root(),
    &[unsound::label::new("foo"), unsound::label::new("bar"), unsound::label::new("baz.rs")]
);

let mut expected = Path::root();
expected.push(unsound::label::new("foo"));
expected.push(unsound::label::new("bar"));
expected.push(unsound::label::new("baz.rs"));

assert_eq!(path, expected);
let path_vec: Vec<Label> = path.0.into();
assert_eq!(
    path_vec,
    vec![Label::root(), unsound::label::new("foo"), unsound::label::new("bar"),
    unsound::label::new("baz.rs")]
);

pub fn with_root(labels: &[Label]) -> Path

Construct a Path using Label::root as the head of the `Path.

Examples

use nonempty::NonEmpty;
use radicle_surf::file_system::{Label, Path};
use radicle_surf::file_system::unsound;

let path = Path::with_root(
    &[unsound::label::new("foo"), unsound::label::new("bar"), unsound::label::new("baz.rs")]
);

let mut expected = Path::root();
expected.push(unsound::label::new("foo"));
expected.push(unsound::label::new("bar"));
expected.push(unsound::label::new("baz.rs"));

assert_eq!(path, expected);
let path_vec: Vec<Label> = path.0.into();
assert_eq!(
    path_vec,
    vec![Label::root(), unsound::label::new("foo"), unsound::label::new("bar"),
    unsound::label::new("baz.rs")]
);

Trait Implementations

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

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

Formats the value using the given formatter.

impl FromStr for Path

type Err = Error

The associated error which can be returned from parsing.

fn from_str(item: &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 IntoCString for Path

fn into_c_string(self) -> Result<CString, Error>

Consume this container, converting it into a CString

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 TryFrom<&'_ str> for Path

type Error = Error

The type returned in the event of a conversion error.

fn try_from(item: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PathBuf> for Path

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path_buf: PathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Path

impl StructuralEq for Path

impl StructuralPartialEq for Path