Struct MergeableFileSystemTree

pub struct MergeableFileSystemTree<Path, FileContent>(/* private fields */)
where
    Path: Ord;

Representation of a filesystem which contains only files and directories.

The serialization of FileContent (content of file) and BTreeMap<Path, Self> (children of directory) must not share the same type. That is, FileContent must be serialized to things other than a dictionary.

Generic parameters:

• Path: Reference to a file in the filesystem.
• FileContent: Content of a file.

Difference from FileSystemTree: FileSystemTree::build cannot write over an existing directory. On the other hand, MergeableFileSystemTree::build either merges the two directories if there’s no conflict.

Methods from Deref<Target = FileSystemTree<Path, FileContent>>

pub fn file_content(&self) -> Option<&FileContent>

Get immutable reference to the file content.

pub fn dir_content(&self) -> Option<&BTreeMap<Path, Self>>

Get immutable reference to the directory content.

pub fn path<'a>( &'a self, path: &'a mut impl Iterator<Item = &'a Path>, ) -> Option<&'a Self>

Get immutable reference to a descendant of any level.

pub fn file_content_mut(&mut self) -> Option<&mut FileContent>

Get mutable reference to the file content.

pub fn dir_content_mut(&mut self) -> Option<&mut BTreeMap<Path, Self>>

Get mutable reference to the directory content.

pub fn path_mut<'a>( &'a mut self, path: &'a mut impl Iterator<Item = &'a Path>, ) -> Option<&'a mut Self>

Get mutable reference to a descendant of any level.

Trait Implementations

impl<Path, FileContent> AsMut<FileSystemTree<Path, FileContent>> for MergeableFileSystemTree<Path, FileContent>

where Path: Ord,

fn as_mut(&mut self) -> &mut FileSystemTree<Path, FileContent>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<Path, FileContent> AsRef<FileSystemTree<Path, FileContent>> for MergeableFileSystemTree<Path, FileContent>

where Path: Ord,

fn as_ref(&self) -> &FileSystemTree<Path, FileContent>

Converts this type into a shared reference of the (usually inferred) input type.

impl<Name, FileContent> Build<Name, Error> for MergeableFileSystemTree<Name, FileContent>

where Name: AsRef<Path> + Ord, FileContent: AsRef<[u8]>,

type BorrowedPath = Path

Build target.

type OwnedPath = PathBuf

Locations of the items in the filesystem.

fn join(prefix: &Self::BorrowedPath, name: &Name) -> Self::OwnedPath

Add prefix to the root of the tree.

fn write_file( path: &Self::BorrowedPath, content: &Self::FileContent, ) -> Result<(), Error>

Write content to a file.

fn create_dir(path: &Self::BorrowedPath) -> Result<(), Error>

Create a directory at root.

fn build<Path>( self, path: Path, ) -> Result<(), BuildError<Self::OwnedPath, Error>>

where Path: AsRef<Self::BorrowedPath>,

Build the tree into the filesystem.

impl<Path, FileContent: Clone> Clone for MergeableFileSystemTree<Path, FileContent>

where Path: Ord + Clone,

fn clone(&self) -> MergeableFileSystemTree<Path, FileContent>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Path, FileContent: Debug> Debug for MergeableFileSystemTree<Path, FileContent>

where Path: Ord + Debug,

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

Formats the value using the given formatter.

impl<Path, FileContent> Deref for MergeableFileSystemTree<Path, FileContent>

where Path: Ord,

type Target = FileSystemTree<Path, FileContent>

The resulting type after dereferencing.

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

Dereferences the value.

impl<Path, FileContent> DerefMut for MergeableFileSystemTree<Path, FileContent>

where Path: Ord,

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

Mutably dereferences the value.

impl<'de, Path, FileContent> Deserialize<'de> for MergeableFileSystemTree<Path, FileContent>

where Path: Ord + Deserialize<'de>, FileContent: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Path, FileContent> From<FileSystemTree<Path, FileContent>> for MergeableFileSystemTree<Path, FileContent>

where Path: Ord,

fn from(value: FileSystemTree<Path, FileContent>) -> Self

Converts to this type from the input type.

impl<Path, FileContent> From<MergeableFileSystemTree<Path, FileContent>> for FileSystemTree<Path, FileContent>

where Path: Ord,

fn from(value: MergeableFileSystemTree<Path, FileContent>) -> Self

Converts to this type from the input type.

impl<Path, FileContent> Node for MergeableFileSystemTree<Path, FileContent>

where Path: Ord,

type FileContent = FileContent

Content of the node if it is a file.

type DirectoryContent = BTreeMap<Path, MergeableFileSystemTree<Path, FileContent>>

Content of the node if it is a directory.

fn read(self) -> NodeContent<FileContent, Self::DirectoryContent>

Read the content of the node.

impl<Path, FileContent: PartialEq> PartialEq for MergeableFileSystemTree<Path, FileContent>

where Path: Ord + PartialEq,

fn eq(&self, other: &MergeableFileSystemTree<Path, FileContent>) -> 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<Path, FileContent> Serialize for MergeableFileSystemTree<Path, FileContent>

where Path: Ord + Serialize, FileContent: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Path, FileContent: Eq> Eq for MergeableFileSystemTree<Path, FileContent>

where Path: Ord + Eq,

impl<Path, FileContent> StructuralPartialEq for MergeableFileSystemTree<Path, FileContent>

where Path: Ord,