Struct Tree 

pub struct Tree<S> { /* private fields */ }

Implementations

impl<S> Tree<S>

pub fn open_inferred<P: AsRef<Path>>( base: P, scheme: S, ) -> Result<Option<Self>, Error>

Open a tree with an inferred prefix part structure and extension constraint.

The result will be empty if and only if the store has no files (even if there are directories).

See the infer_prefix_part_lengths and infer_extension_constraint functions for important qualifications.

impl<S: Scheme> Tree<S>

pub fn path(&self, name: S::NameRef<'_>) -> Result<PathBuf, String>

Return the path through the tree for the given name, including any fixed extension.

pub fn open_file(&self, name: S::NameRef<'_>) -> Result<Option<File>, Error>

Try to open a file for reading for the given name, including any fixed extension.

Note that this function will probably not do the right thing for any extension configuration that does not either prohibit extensions or require a fixed extension.

pub fn create_file(&self, name: S::NameRef<'_>) -> Result<Option<File>, Error>

Try to create a file for writing for the given name, including any fixed extension.

Note that this function will probably not do the right thing for any extension configuration that does not either prohibit extensions or require a fixed extension.

pub fn entries(&self) -> Entries<'_, S>

impl Tree<Identity>

pub fn builder<P: AsRef<Path>>(base: P) -> TreeBuilder<Identity>

pub fn infer_prefix_part_lengths<P: AsRef<Path>>( base: P, ) -> Result<Option<Vec<usize>>, Error>

Infer the prefix part lengths used to create a store.

The result will be empty if and only if the store has no files (even if there are directories).

If this function returns a result, it is guaranteed to be correct if the store is valid, but the validity is not checked.

pub fn infer_extension_constraint<P: AsRef<Path>>( base: P, ) -> Result<Option<Extension>, Error>

Infer the extension constraint used to create a store.

The result will be empty if and only if the store has no files (even if there are directories).

This function can only infer the extension constraint if it either prohibits extensions or requires all files to have the same extension.

pub fn infer_extension_constraint_rec<P: AsRef<Path>>( current: P, ) -> Result<Option<Extension>, Error>

Trait Implementations

impl<S: Clone> Clone for Tree<S>

fn clone(&self) -> Tree<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Tree<S>

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

Formats the value using the given formatter.

impl<S: PartialEq> PartialEq for Tree<S>

fn eq(&self, other: &Tree<S>) -> 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<S: Eq> Eq for Tree<S>

impl<S> StructuralPartialEq for Tree<S>