Enum FileTreeNode 

#[non_exhaustive]
pub enum FileTreeNode {
    File {
        contents: Vec<u8>,
    },
    Directory {
        files: HashMap<String, FileTreeNode>,
    },
}

A node in the file tree structure

Out-of-crate callers build these; Quill::from_tree takes one. #[non_exhaustive] leaves variant construction untouched, so the building direction is unaffected.

Symlinks are refused at the loader rather than modelled here.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

File

A file with its contents

Fields

contents: Vec<u8>

The file contents as bytes or UTF-8 string

Directory

A directory containing other files and directories

Fields

files: HashMap<String, FileTreeNode>

The files and subdirectories in this directory

Implementations

impl FileTreeNode

pub fn get_node<P>(&self, path: P) -> Option<&FileTreeNode>

where P: AsRef<Path>,

Get a file or directory node by path

pub fn get_file<P>(&self, path: P) -> Option<&[u8]>

where P: AsRef<Path>,

Get file contents by path

pub fn file_exists<P>(&self, path: P) -> bool

where P: AsRef<Path>,

Check if a file exists at the given path

pub fn dir_exists<P>(&self, path: P) -> bool

where P: AsRef<Path>,

Check if a directory exists at the given path

pub fn list_files<P>(&self, dir_path: P) -> Vec<String>

where P: AsRef<Path>,

List all files in a directory (non-recursive)

pub fn list_subdirectories<P>(&self, dir_path: P) -> Vec<String>

where P: AsRef<Path>,

List all subdirectories in a directory (non-recursive)

pub fn list_directories<P>(&self, dir_path: P) -> Vec<PathBuf>

where P: AsRef<Path>,

List all directories in a directory, as paths joined onto dir_path. The name twin is list_subdirectories; results stay relative to the receiver either way.

pub fn find_files<P>(&self, pattern: P) -> Vec<PathBuf>

where P: AsRef<Path>,

Get all files matching a pattern (supports glob-style wildcards). An invalid pattern matches nothing.

pub fn insert<P>( &mut self, path: P, node: FileTreeNode, ) -> Result<(), Box<dyn Error + Sync + Send>>

where P: AsRef<Path>,

Insert a file or directory at the given path

pub fn flatten(&self) -> Vec<(String, Vec<u8>)>

Flatten the tree into (path, contents) pairs: the inverse of building a tree by insert-ing each path. Paths are "/"-joined and relative (no leading slash), exactly the key shape the WASM Quill.fromTree boundary consumes, so from_tree(flatten(t)) round-trips every file. Output is sorted by path for deterministic ordering (the construction side stores children in a HashMap, which has no inherent order).

Only files are emitted: an EMPTY directory yields no entry and so is not reconstructed by a flatten → insert round trip. This is intentional (quill bundles are file-addressed and nothing in load/render depends on empty directories) but it means the round trip preserves file contents, not exact directory structure.

Trait Implementations

impl Clone for FileTreeNode

fn clone(&self) -> FileTreeNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileTreeNode

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

Formats the value using the given formatter.