Struct DirDescendant 

pub struct DirDescendant<T, P: PathType + ?Sized = Path> { /* private fields */ }

A single directory descendant, identified by its path relative to the ascendant.

It also stores the path relative to the “root.”

Implementations

impl<T, P: PathType + ?Sized> DirDescendant<T, P>

pub fn new( name: impl Into<P::PathSegmentOwned>, path: impl Into<P::OwnedPath>, path_relative_to_ascendant: impl Into<P::OwnedPath>, value: T, ) -> Self

Create a new directory descendant from its parts.

Examples

use std::ffi::OsString;
use std::path::Path;
use std::path::PathBuf;
use dir_structure::dir_descendants::DirDescendant;

let descendant = DirDescendant::<_, Path>::new(
    "child".to_owned(),
    "root/a/b/child".to_owned(),
    "a/b/child".to_owned(),
    String::from("child_value"),
);
assert_eq!(descendant.name(), &OsString::from("child"));
assert_eq!(descendant.path(), &PathBuf::from("root/a/b/child"));
assert_eq!(descendant.path_relative_to_ascendant(), &PathBuf::from("a/b/child"));
assert_eq!(descendant.value(), &String::from("child_value"));

pub fn name(&self) -> &P::PathSegmentOwned

Get the name of the directory descendant.

Examples

use std::ffi::OsString;
use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);
assert_eq!(descendant.name(), &OsString::from("child"));

pub fn path(&self) -> &P

Get the path of the directory descendant.

Examples

use std::path::PathBuf;
use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);
assert_eq!(descendant.path(), &PathBuf::from("root/a/b/child"));

pub fn path_relative_to_ascendant(&self) -> &P

Get the path relative to the ascendant.

Examples

use std::path::PathBuf;
use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);
assert_eq!(descendant.path_relative_to_ascendant(), &PathBuf::from("a/b/child"));

pub fn value(&self) -> &T

Get the value of the descendant.

Examples

use std::path::PathBuf;
use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);
assert_eq!(descendant.value(), &String::from("child_value"));

pub fn into_value(self) -> T

Turns the descendant into its value.

Examples

use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);
assert_eq!(descendant.into_value(), String::from("child_value"));

pub fn into_name(self) -> P::PathSegmentOwned

Turns the descendant into its name.

Examples

use std::ffi::OsString;
use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);
assert_eq!(descendant.into_name(), OsString::from("child"));

pub fn into_path(self) -> P::OwnedPath

Turns the descendant into its path.

Examples

use std::path::PathBuf;
use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);
assert_eq!(descendant.into_path(), PathBuf::from("root/a/b/child"));

pub fn name_mut(&mut self) -> &mut P::PathSegmentOwned

Get a mutable reference to the name of the directory descendant. This is a mutable version of DirDescendant::name.

Examples

use std::ffi::OsString;
use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let mut descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);
*descendant.name_mut() = OsString::from("new_child");
assert_eq!(descendant.name(), &OsString::from("new_child"));

pub fn value_mut(&mut self) -> &mut T

Get a mutable reference to the value of the directory descendant. This is a mutable version of DirDescendant::value.

Examples

use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let mut descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);
*descendant.value_mut() = String::from("new_child_value");
assert_eq!(descendant.value(), &String::from("new_child_value"));

pub fn as_ref(&self) -> DirDescendant<&T, P>

Clones the directory name and paths, but makes the value a reference to the original value.

Examples

use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);

let ref_descendant = descendant.as_ref();
assert_eq!(ref_descendant.name(), descendant.name());
assert_eq!(ref_descendant.path(), descendant.path());
assert_eq!(ref_descendant.path_relative_to_ascendant(), descendant.path_relative_to_ascendant());
assert_eq!(ref_descendant.value(), &descendant.value());

pub fn as_mut(&mut self) -> DirDescendant<&mut T, P>

Clones the directory name and paths, but makes the value a mutable reference to the original value.

Examples

use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let mut descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);

let mut mut_ref_descendant = descendant.as_mut();
mut_ref_descendant.value_mut().push_str("_new");
assert_eq!(descendant.value(), &String::from("child_value_new"));

pub fn map<F, U>(self, f: F) -> DirDescendant<U, P>

where F: FnOnce(T) -> U,

Maps the value of the directory descendant.

Examples

use std::path::Path;
use dir_structure::dir_descendants::DirDescendant;

let descendant = DirDescendant::<_, Path>::new(
    "child",
    "root/a/b/child",
    "a/b/child",
    String::from("child_value"),
);
let mapped = descendant.map(|v| v.len());
assert_eq!(mapped.value(), &11);

Trait Implementations

impl<T, P: PathType + ?Sized> AssertEq for DirDescendant<T, P>

where for<'__trivial> P::PathSegmentOwned: AssertEq<P::PathSegmentOwned> + Debug, for<'__trivial, '__trivial> P::OwnedPath: AssertEq<P::OwnedPath> + Debug, for<'__trivial> T: AssertEq<T> + Debug,

fn assert_eq( &self, other: &Self, path: &mut AssertPath, init_left: &impl Display, init_right: &impl Display, )

Asserts that self is equal to other, panicking if they are not equal.

impl<T: Clone, P: PathType + ?Sized> Clone for DirDescendant<T, P>

where P::PathSegmentOwned: Clone, P::OwnedPath: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, P: PathType + ?Sized> Debug for DirDescendant<T, P>

where P::PathSegmentOwned: Debug, P::OwnedPath: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for DirDescendant<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for DirDescendant<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T, F: FolderFilter<P> + FolderRecurseFilter<P> + FileFilter<P>, P: PathType + ?Sized> Extend<DirDescendant<T, P>> for DirDescendants<T, F, P>

fn extend<I: IntoIterator<Item = DirDescendant<T, 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, F: FolderFilter<P> + FolderRecurseFilter<P> + FileFilter<P>, P: PathType + ?Sized> FromIterator<DirDescendant<T, P>> for DirDescendants<T, F, P>

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

Creates a value from an iterator.

impl<T: Hash, P: Hash + PathType + ?Sized> Hash for DirDescendant<T, P>

where P::PathSegmentOwned: Hash, P::OwnedPath: Hash,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord, P: Ord + PathType + ?Sized> Ord for DirDescendant<T, P>

where P::PathSegmentOwned: Ord, P::OwnedPath: Ord,

fn cmp(&self, other: &DirDescendant<T, P>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, P: PartialEq + PathType + ?Sized> PartialEq for DirDescendant<T, P>

where P::PathSegmentOwned: PartialEq, P::OwnedPath: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: PartialOrd, P: PartialOrd + PathType + ?Sized> PartialOrd for DirDescendant<T, P>

where P::PathSegmentOwned: PartialOrd, P::OwnedPath: PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Eq, P: Eq + PathType + ?Sized> Eq for DirDescendant<T, P>

where P::PathSegmentOwned: Eq, P::OwnedPath: Eq,

impl<T, P: PathType + ?Sized> StructuralPartialEq for DirDescendant<T, P>