Struct DirChildSingle 

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

A structure that represents a directory where only one of the children pass the filter F.

This is useful if you want to select one specific file, by the file prefix / stem, but you don’t care about the extension.

Implementations

impl<T, F: Filter<P>, P: PathType + ?Sized> DirChildSingle<T, F, P>

pub fn new(file_name: impl Into<P::PathSegmentOwned>, value: T) -> Self

Creates a new DirChildSingle with the specified file name and value.

Examples

use std::ffi::OsString;
use dir_structure::NoFilter;
use dir_structure::dir_children::DirChildSingle;

let d = DirChildSingle::<_, NoFilter>::new("file.txt", "file".to_owned());
assert_eq!(d.file_name(), &OsString::from("file.txt"));
assert_eq!(d.value(), &"file".to_owned());

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

Gets the file name of the child (or the name of the directory; the last segment in the path).

Examples

use std::ffi::OsString;
use dir_structure::NoFilter;
use dir_structure::dir_children::DirChildSingle;

let d = DirChildSingle::<_, NoFilter>::new("file.txt", "file".to_owned());
assert_eq!(d.file_name(), &OsString::from("file.txt"));
assert_eq!(d.value(), &"file".to_owned());

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

Gets the file name of the child (or the name of the directory; the last segment in the path). Mutable version of file_name.

Examples

use std::ffi::OsString;
use dir_structure::NoFilter;
use dir_structure::dir_children::DirChildSingle;

let mut d = DirChildSingle::<_, NoFilter>::new("file.txt", "file".to_owned());
assert_eq!(d.file_name_mut(), &mut OsString::from("file.txt"));
assert_eq!(d.value_mut(), &mut "file".to_owned());

pub fn value(&self) -> &T

Gets the value of the child.

Examples

use std::ffi::OsString;
use dir_structure::NoFilter;
use dir_structure::dir_children::DirChildSingle;

let d = DirChildSingle::<_, NoFilter>::new("file.txt", "file".to_owned());
assert_eq!(d.value(), &"file".to_owned());

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

Gets the value of the child. Mutable reference version of Self::value.

Examples

use std::ffi::OsString;
use dir_structure::NoFilter;
use dir_structure::dir_children::DirChildSingle;

let mut d = DirChildSingle::<_, NoFilter>::new("file.txt", "file".to_owned());
assert_eq!(d.value_mut(), &mut "file".to_owned());

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

Converts &DirChildSingle<T, F> to DirChildSingle<&T, F>.

Examples

use std::ffi::OsString;
use dir_structure::NoFilter;
use dir_structure::dir_children::DirChildSingle;

let d = DirChildSingle::<_, NoFilter>::new("file.txt", "file".to_owned());
let d_ref: DirChildSingle<&String, NoFilter> = d.as_ref();
assert_eq!(d_ref.file_name(), &OsString::from("file.txt"));
assert_eq!(d_ref.value(), &&"file".to_owned());

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

Converts &mut DirChildSingle<T, F> to DirChildSingle<&mut T, F>.

This clones the OsString and PathBuf used for the name and path.

Examples

use std::ffi::OsString;
use dir_structure::NoFilter;
use dir_structure::dir_children::DirChildSingle;

let mut d = DirChildSingle::<_, NoFilter>::new("file.txt", "file".to_owned());
let mut d_mut: DirChildSingle<&mut String, NoFilter> = d.as_mut();
d_mut.value_mut().push_str("_modified");
assert_eq!(d.value(), &"file_modified".to_owned());

pub fn map<T2, F2>(self, f: F2) -> DirChildSingle<T2, F, P>

where F2: FnOnce(T) -> T2,

Maps the value of the child to a new value.

Examples

use std::ffi::OsString;
use dir_structure::NoFilter;
use dir_structure::dir_children::DirChildSingle;

let d = DirChildSingle::<_, NoFilter>::new("file.txt", "file".to_owned());
let d2 = d.map(|s| s.to_uppercase());
assert_eq!(d2.value(), &"FILE".to_owned());

pub fn map_filter<F2>(self) -> DirChildSingle<T, F2, P>

where F2: Filter<P>,

Map the filter to another Filter type.

Examples

use std::ffi::OsString;
use dir_structure::NoFilter;
use dir_structure::dir_children::DirChildSingle;
use dir_structure::traits::vfs::PathType;

struct Filt;

impl<P: PathType + ?Sized> dir_structure::dir_children::Filter<P> for Filt {
    fn allows(_path: &P) -> bool {
        true
    }
}

let d = DirChildSingle::<_, NoFilter>::new("file.txt", "file".to_owned());
let d2: DirChildSingle<_, Filt> = d.map_filter::<Filt>();
assert_eq!(d2.file_name(), &OsString::from("file.txt"));
assert_eq!(d2.value(), &"file".to_owned());

Trait Implementations

impl<T, F: Filter<P>, P: PathType + ?Sized> AssertEq for DirChildSingle<T, F, P>

where for<'__trivial> P::PathSegmentOwned: AssertEq<P::PathSegmentOwned> + 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, F: Clone + Filter<P>, P: Clone + PathType + ?Sized> Clone for DirChildSingle<T, F, P>

where P::PathSegmentOwned: Clone,

fn clone(&self) -> DirChildSingle<T, F, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

where F: Filter<P>, T: Debug, <P as PathType>::PathSegmentOwned: Debug,

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

Formats the value using the given formatter.

impl<T, F, P: PathType + ?Sized> Deref for DirChildSingle<T, F, P>

where F: Filter<P>,

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, F, P: PathType + ?Sized> DerefMut for DirChildSingle<T, F, P>

where F: Filter<P>,

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

Mutably dereferences the value.

impl<T: Hash, F: Hash + Filter<P>, P: Hash + PathType + ?Sized> Hash for DirChildSingle<T, F, P>

where P::PathSegmentOwned: 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, F: Ord + Filter<P>, P: Ord + PathType + ?Sized> Ord for DirChildSingle<T, F, P>

where P::PathSegmentOwned: Ord,

fn cmp(&self, other: &DirChildSingle<T, F, 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, F: PartialEq + Filter<P>, P: PartialEq + PathType + ?Sized> PartialEq for DirChildSingle<T, F, P>

where P::PathSegmentOwned: PartialEq,

fn eq(&self, other: &DirChildSingle<T, F, 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, F: PartialOrd + Filter<P>, P: PartialOrd + PathType + ?Sized> PartialOrd for DirChildSingle<T, F, P>

where P::PathSegmentOwned: PartialOrd,

fn partial_cmp(&self, other: &DirChildSingle<T, F, 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<'a, T, F, Vfs: Vfs<'a>> ReadFrom<'a, Vfs> for DirChildSingle<T, F, Vfs::Path>

where T: ReadFrom<'a, Vfs>, F: Filter<Vfs::Path> + 'a,

fn read_from(path: &Vfs::Path, vfs: Pin<&'a Vfs>) -> VfsResult<Self, Vfs>

where Self: Sized,

Reads the structure from the specified path, which can be either a file or a directory.

impl<'a, T, F: Filter<Vfs::Path>, Vfs: WriteSupportingVfs<'a>> WriteTo<'a, Vfs> for DirChildSingle<T, F, Vfs::Path>

where T: WriteTo<'a, Vfs>,

fn write_to(&self, path: &Vfs::Path, vfs: Pin<&'a Vfs>) -> VfsResult<(), Vfs>

Writes the structure to the specified path.

impl<T: Eq, F: Eq + Filter<P>, P: Eq + PathType + ?Sized> Eq for DirChildSingle<T, F, P>

where P::PathSegmentOwned: Eq,

impl<T, F: Filter<P>, P: PathType + ?Sized> StructuralPartialEq for DirChildSingle<T, F, P>