Crate fs_tree

source ·
Expand description

Filesystem trie-like tree structure for commons operations.

Given a path, you can load a FsTree which might represent a regular file, directory, or symlink.

Features:

  • Aware of regular files, directories and symlinks.
  • Read from your filesystem.
  • Merge trees.
  • Get the difference of two trees.
  • Macros for creating trees more easily (WIP).
  • Tree iteration.
    • Supports useful tree filters.
    • You can perform operations on the iteration results (e.g. read each file and link them).

When not to use:

  • If you just want to iterate a directory, use WalkDir instead.
  • If you want to use a text trie directly, use other crate too.

When to use:

  • You need to easily load a file type-aware trie from your filesystem and compare with other tries.

Modules

  • FsTree iterators.
  • Exposed functions that are used internally by this crate.

Macros

  • Same as trees, but panics if more than a single one is provided.
  • Macro for declaring a FsTree literal.

Structs

  • A filesystem tree recursive type.

Enums

  • Errors generated inside of the fs-tree crate.
  • A filesystem tree recursive enum.

Type Aliases

  • Result for all fs-tree crate errors.