Struct build_fs_tree::MergeableFileSystemTree

[+] Show declaration

pub struct MergeableFileSystemTree<Path, FileContent>(_)
 where
    Path: Ord;

[−] Expand description

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, [+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl<Path, FileContent> AsRef<FileSystemTree<Path, FileContent>> for MergeableFileSystemTree<Path, FileContent> where
    Path: Ord, [+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl<Name, FileContent> Build<Name, Error> for MergeableFileSystemTree<Name, FileContent> where
    Name: AsRef<Path> + Ord,
    FileContent: AsRef<[u8]>, [+]

[+] Show hidden undocumented items

type Path = PathBuf

Locations of the items in the filesystem.

fn join(prefix: &Self::Path, name: &Name) -> Self::Path[−]

Add prefix to the root of the tree.

fn write_file(
    path: &Self::Path,
    content: &Self::FileContent
) -> Result<(), Error>[−]

Write content to a file.

fn create_dir(path: &Self::Path) -> Result<(), Error>[−]

Create a directory at root.

fn build(self, path: &Self::Path) -> Result<(), BuildError<Self::Path, Error>>[−]

Build the tree into the filesystem.

impl<Path: Clone, FileContent: Clone> Clone for MergeableFileSystemTree<Path, FileContent> where
    Path: Ord, [+]

[+] Show hidden undocumented items

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

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<Path: Debug, FileContent: Debug> Debug for MergeableFileSystemTree<Path, FileContent> where
    Path: Ord, [+]

[+] Show hidden undocumented items

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, [+]

[+] Show hidden undocumented items

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, [+]

[+] Show hidden undocumented items

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,
    Path: Deserialize<'de>,
    FileContent: Deserialize<'de>, [+]

[+] Show hidden undocumented items

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

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

impl<Path, FileContent> From<FileSystemTree<Path, FileContent>> for MergeableFileSystemTree<Path, FileContent> where
    Path: Ord, [+]

[+] Show hidden undocumented items

fn from(
    original: FileSystemTree<Path, FileContent>
) -> MergeableFileSystemTree<Path, FileContent>[−]

Performs the conversion.

impl<Path, FileContent> From<MergeableFileSystemTree<Path, FileContent>> for FileSystemTree<Path, FileContent> where
    Path: Ord, [+]

[+] Show hidden undocumented items

fn from(original: MergeableFileSystemTree<Path, FileContent>) -> Self[−]

Performs the conversion.

impl<Path, FileContent> Node for MergeableFileSystemTree<Path, FileContent> where
    Path: Ord, [+]

[+] Show hidden undocumented items

type FileContent = FileContent

Content of the node if it is a file.

type DirectoryContent = BTreeMap<Path, Self>

Content of the node if it is a directory.

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

Read the content of the node.

impl<Path: PartialEq, FileContent: PartialEq> PartialEq<MergeableFileSystemTree<Path, FileContent>> for MergeableFileSystemTree<Path, FileContent> where
    Path: Ord, [+]

[+] Show hidden undocumented items

fn eq(&self, other: &MergeableFileSystemTree<Path, FileContent>) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MergeableFileSystemTree<Path, FileContent>) -> bool[−]

This method tests for !=.

impl<Path, FileContent> Serialize for MergeableFileSystemTree<Path, FileContent> where
    Path: Ord,
    Path: Serialize,
    FileContent: Serialize, [+]

[+] Show hidden undocumented items

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> StructuralEq for MergeableFileSystemTree<Path, FileContent> where
    Path: Ord, 

impl<Path, FileContent> StructuralPartialEq for MergeableFileSystemTree<Path, FileContent> where
    Path: Ord,