Struct IndexBuilder 

pub struct IndexBuilder { /* private fields */ }

Builds valid sidecar index files from high-level calls.

Example

let data = IndexBuilder::new()
    .dir("")
    .file("", "hello.txt", 0o644)
    .build();

Implementations

impl IndexBuilder

pub fn new() -> Self

Create a new empty builder.

pub fn dir(self, path: &str) -> Self

Add a directory to the index.

pub fn opaque_dir(self, path: &str) -> Self

Add an opaque directory to the index.

pub fn file(self, dir: &str, name: &str, mode: u32) -> Self

Add a regular file entry. Mode permissions only (S_IFREG is added automatically).

pub fn subdir(self, dir: &str, name: &str, mode: u32) -> Self

Add a subdirectory entry. Mode permissions only (S_IFDIR is added automatically).

pub fn symlink(self, dir: &str, name: &str) -> Self

Add a symlink entry.

pub fn whiteout(self, dir: &str, name: &str) -> Self

Add a whiteout entry (masks a name from lower layers).

pub fn tombstone(self, dir: &str, name: &str) -> Self

Add an overflow tombstone name for a directory.

pub fn hardlink(self, ino: u64, path: &str) -> Self

Add a hardlink reference entry.

pub fn build(self) -> Vec<u8>

Build valid index bytes.

pub fn build_to_file(self, path: &Path) -> Result<()>

Write valid index to a file.

Trait Implementations

impl Default for IndexBuilder

fn default() -> Self

Returns the “default value” for a type.