Struct dir_structure::DirChildren

pub struct DirChildren<T>where
    T: DirStructureItem,{
    pub self_path: PathBuf,
    pub children: Vec<DirChild<T>>,
}

A directory structure where we don’t know the names of the folders at compile-time, and as such we cannot use the derive macro.

Instead we know that all the entries in the directory are folders, and that they all have the same structure inside (defined by the [T] type parameter), or they are all files (which can be read with DirChildren<String> for example).

In either case, [<T as ReadFrom>::read_from] must be able to read all the entries in the directory.

The WriteTo implementation will directly write the children to the directory it is passed, with no regards to the path stored in self_path.

Fields

self_path: PathBuf

The path to the root directory.

This path doesn’t influence writing in any way, it is only to point out the directory after it has been read and parsed.

children: Vec<DirChild<T>>

The children of the root directory.

Implementations

impl<T> DirChildren<T>where T: DirStructureItem,

pub fn new() -> Self

Creates an empty DirChildren, with no children.

pub fn with_children_from_iter( self_path: impl Into<PathBuf>, children: impl IntoIterator<Item = DirChild<T>> ) -> Self

Creates a DirChildren with the given path and children.

pub fn len(&self) -> usize

Returns the number of children.

pub fn get(&self, index: usize) -> Option<&DirChild<T>>

Gets the child at the specified index.

pub fn get_name(&self, name: impl AsRef<OsStr>) -> Option<&DirChild<T>>

Gets the child with the specified “file” name (last segment of path).

pub fn iter(&self) -> DirChildrenIter<'_, T>

Returns an iterator over the children.

Trait Implementations

impl<T> IntoIterator for DirChildren<T>where T: DirStructureItem,

type Item = DirChild<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<<DirChildren<T> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> ReadFrom for DirChildren<T>where T: DirStructureItem,

fn read_from(path: &Path) -> Result<Self>where Self: Sized,

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

impl<T> WriteTo for DirChildren<T>where T: DirStructureItem,

fn write_to(&self, path: &Path) -> Result<()>

Writes the structure to the specified path.