Struct radicle_surf::file_system::Path [−][src]
A non-empty set of Label
s to define a path to a directory or file.
Path
tends to be used for insertion or find operations.
Implementations
impl Path
[src]
impl Path
[src]pub fn new(label: Label) -> Path
[src]
Create a new Path
with a single Label
.
pub fn root() -> Self
[src]
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
[src]
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)
[src]
Append two Path
s 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)
[src]
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>
[src]
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>
[src]
Iterator over the Label
s 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])
[src]
Get the first Label
in the Path
and the rest of the Label
s
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)
[src]
Get the prefix of the Label
s 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
[src]
Construct a Path
given at least one Label
followed by 0 or more
Label
s.
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
[src]
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 IntoCString for Path
[src]
impl IntoCString for Path
[src]fn into_c_string(self) -> Result<CString, Error>
[src]
impl StructuralEq for Path
[src]
impl StructuralEq for Path
[src]impl StructuralPartialEq for Path
[src]
impl StructuralPartialEq for Path
[src]Auto Trait Implementations
impl RefUnwindSafe for Path
impl RefUnwindSafe for Path
impl UnwindSafe for Path
impl UnwindSafe for Path
Blanket Implementations
impl<T> FmtForward for T
impl<T> FmtForward for T
pub fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
Self: Binary,
pub fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Self: Display,
pub fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Self: LowerExp,
pub fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Self: LowerHex,
pub fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
Self: Octal,
pub fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Self: Pointer,
pub fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Self: UpperExp,
pub fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Self: UpperHex,
impl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
pub fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
pub fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
R: 'a,
pub fn pipe_ref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self) -> R
) -> R where
R: 'a,
&'a mut self,
func: impl FnOnce(&'a mut Self) -> R
) -> R where
R: 'a,
pub fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
pub fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
pub fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
R: 'a,
U: 'a + ?Sized,
Self: AsRef<U>,
R: 'a,
U: 'a + ?Sized,
pub fn pipe_as_mut<'a, U, R>(
&'a mut self,
func: impl FnOnce(&'a mut U) -> R
) -> R where
Self: AsMut<U>,
R: 'a,
U: 'a + ?Sized,
&'a mut self,
func: impl FnOnce(&'a mut U) -> R
) -> R where
Self: AsMut<U>,
R: 'a,
U: 'a + ?Sized,
pub fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
pub fn pipe_deref_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a,
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a,
impl<T> PipeAsRef for T
impl<T> PipeAsRef for T
pub fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
Self: AsRef<T>,
T: 'a,
R: 'a,
pub fn pipe_as_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,
impl<T> PipeBorrow for T
impl<T> PipeBorrow for T
pub fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
Self: Borrow<T>,
T: 'a,
R: 'a,
pub fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,
impl<T> PipeDeref for T
impl<T> PipeDeref for T
pub fn pipe_deref<'a, R>(
&'a self,
func: impl FnOnce(&'a Self::Target) -> R
) -> R where
Self: Deref,
R: 'a,
&'a self,
func: impl FnOnce(&'a Self::Target) -> R
) -> R where
Self: Deref,
R: 'a,
pub fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,
impl<T> Tap for T
impl<T> Tap for T
pub fn tap(self, func: impl FnOnce(&Self)) -> Self
pub fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self
pub fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Self: Borrow<B>,
B: ?Sized,
pub fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Self: BorrowMut<B>,
B: ?Sized,
pub fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Self: AsRef<R>,
R: ?Sized,
pub fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Self: AsMut<R>,
R: ?Sized,
pub fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
Self: Deref<Target = T>,
T: ?Sized,
pub fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
pub fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
pub fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
pub fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Self: Borrow<B>,
B: ?Sized,
pub fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Self: BorrowMut<B>,
B: ?Sized,
pub fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Self: AsRef<R>,
R: ?Sized,
pub fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Self: AsMut<R>,
R: ?Sized,
pub fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
Self: Deref<Target = T>,
T: ?Sized,
pub fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
impl<T, U> TapAsRef<U> for T where
U: ?Sized,
impl<T, U> TapAsRef<U> for T where
U: ?Sized,
pub fn tap_ref<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,
Self: AsRef<T>,
F: FnOnce(&T) -> R,
pub fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,
Self: AsRef<T>,
F: FnOnce(&T) -> R,
pub fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
pub fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
impl<T, U> TapBorrow<U> for T where
U: ?Sized,
impl<T, U> TapBorrow<U> for T where
U: ?Sized,
pub fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
Self: Borrow<T>,
F: FnOnce(&T) -> R,
pub fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
Self: Borrow<T>,
F: FnOnce(&T) -> R,
pub fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
pub fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
impl<T> TapDeref for T
impl<T> TapDeref for T
pub fn tap_deref<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Self: Deref,
F: FnOnce(&Self::Target) -> R,
pub fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Self: Deref,
F: FnOnce(&Self::Target) -> R,
pub fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
pub fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,