Struct Builder 

pub struct Builder { /* private fields */ }

Builds a TFS image.

Implementations

impl Builder

pub fn new(total_blocks: usize) -> Builder

A freshly formatted image of total_blocks blocks.

The layout is derived rather than fixed: the allocation map is sized to cover the image at one tryte per block, and the inode table is sized to one inode per four blocks, which is generous for a small disk and costs little.

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

The finished image.

pub fn from_image(bytes: Vec<u8>) -> Builder

Reopens an existing image, reading its layout from the superblock.

For a host inspecting what a guest wrote. The layout fields are read back rather than recomputed, so an image built by something else is still readable as long as its superblock is honest.

pub fn dir_len(&self, inode: i64) -> i64

How many entries a directory holds.

pub fn inode_direct(&self, inode: i64, index: usize) -> i64

A direct block pointer of an inode, for a host checking allocation.

pub fn inode_kind(&self, inode: i64) -> i64

The kind of an inode, for a host checking what a guest created.

pub fn read_file(&self, inode: i64) -> Vec<u8>

The contents of a file inode.

pub fn bytes(&self) -> &[u8]

The bytes so far, for inspection without consuming the builder.

pub fn data_start(&self) -> usize

First block available for data.

pub fn is_block_used(&self, block: usize) -> bool

True if the allocation map marks block as in use.

pub fn lookup(&self, dir: i64, name: &str) -> Option<i64>

Finds name in directory dir.

pub fn mkdir(&mut self, path: &str) -> Result<i64, BuildError>

Creates a directory at path, which must not already exist.

Parent directories must exist. path is absolute with or without a leading slash.

pub fn write_file(&mut self, path: &str, data: &[u8]) -> Result<i64, BuildError>

Creates a file at path holding data, one byte per tryte.