Struct Dtry

pub struct Dtry<T>(/* private fields */);

A directory.

A Dtry<T> consists of a mapping from FieldNames to directory entries, where a directory entry is either a “File” (DtryEntry::File), that is an element of T, or a “subdirectory” (DtryEntry::SubDir), which is just another directory.

The terminology is slightly different from the directories paper; in the directories paper we call DtryEntry a directory, and Dtry is just the internal node case of DtryEntry (internal node as opposed to leaf node). This makes Dtry no longer a monad (there isn’t a unit), but it’s slightly more convenient for our use case here (keeping track of specializations).

Implementations

impl<T> Dtry<T>

pub fn map<S>(&self, f: &impl Fn(&T) -> S) -> Dtry<S>

Produce a new directory given by mapping f over all of the DtryEntry::File nodes.

pub fn empty() -> Dtry<T>

Constructor for the empty directory.

pub fn is_empty(&self) -> bool

Returns whether the directory is empty

pub fn entries( &self, ) -> impl Iterator<Item = (&FieldName, &(LabelSegment, DtryEntry<T>))>

Iterate through the entries of the directory

pub fn entry(&self, field: &FieldName) -> Option<&DtryEntry<T>>

Get the entry for field if it exists

pub fn singleton(path: &[(FieldName, LabelSegment)], val: T) -> Self

Create a singleton directory with just one entry at the given path

impl<T: Clone> Dtry<T>

pub fn flatten(&self) -> Vec<(QualifiedName, QualifiedLabel, T)>

Produce the list of paths in self that refer to files, along with the value of the files that they refer to

Trait Implementations

impl<T: Clone> Clone for Dtry<T>

fn clone(&self) -> Dtry<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> From<IndexMap<NameSegment, (LabelSegment, DtryEntry<T>)>> for Dtry<T>

fn from(value: IndexMap<FieldName, (LabelSegment, DtryEntry<T>)>) -> Self

Converts to this type from the input type.