Struct Builder 

pub struct Builder { /* private fields */ }

The metadata builder.

See module level documentations.

Implementations

impl Builder

pub fn new(root_meta: &InodeMetadata) -> Self

Create a builder with default configurations.

pub fn new_with_config(config: &Config, root_meta: &InodeMetadata) -> Self

Create a builder with custom configurations.

pub fn block_size(&self) -> NonZero<u32>

Get the configured block size.

pub fn root(&self) -> DirId

Get the implicitly created root directory.

pub fn put_dir( &mut self, parent: DirId, name: &str, meta: &InodeMetadata, ) -> Result<DirId>

Add an empty directory under a directory.

Errors

Return Err if either:

• Inode count overflows.
• Directory entry count overflows.
• There is already an entry with the same name in the directory.

pub fn put_hard_link( &mut self, parent: DirId, name: &str, inode: impl Into<LinkableInodeId>, ) -> Result<()>

Add a hard link to an existing inode under a directory.

Errors

See Builder::put_dir.

pub fn put_file( &mut self, parent: DirId, name: &str, meta: &InodeMetadata, chunks: impl IntoIterator<Item = Chunk>, ) -> Result<FileId>

Add a regular file under a directory.

Panics

Panics if any chunk has a offset exceeding Config::block_size.

Errors

See Builder::put_dir.

pub fn put_symlink( &mut self, parent: DirId, name: &str, meta: &InodeMetadata, target: &str, ) -> Result<LinkableInodeId>

Add a symbolic link (symlink) under a directory.

Errors

See Builder::put_dir.

pub fn put_block_device( &mut self, parent: DirId, name: &str, meta: &InodeMetadata, device_id: u64, ) -> Result<LinkableInodeId>

Add a block device inode under a directory.

Errors

See Builder::put_dir.

pub fn put_char_device( &mut self, parent: DirId, name: &str, meta: &InodeMetadata, device_id: u64, ) -> Result<LinkableInodeId>

Add a character device inode under a directory.

Errors

See Builder::put_dir.

pub fn put_fifo( &mut self, parent: DirId, name: &str, meta: &InodeMetadata, ) -> Result<LinkableInodeId>

Add a FIFO (named pipe) inode under a directory.

Errors

See Builder::put_dir.

pub fn put_socket( &mut self, parent: DirId, name: &str, meta: &InodeMetadata, ) -> Result<LinkableInodeId>

Add a socket inode under a directory.

Errors

See Builder::put_dir.

pub fn finish(self) -> Result<Metadata>

Finalize and construct the result Metadata.

Errors

Returns Err if the hierarchy is invalid, or exceeds certain limitations, including and not limited to:

• Duplicated entry names in a directory.
• Any (intermediate) low-level structures exceeds 2³² bytes. See module level documentations.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.