Struct conserve::BlockDir

pub struct BlockDir {
    pub path: PathBuf,
}

A readable, writable directory within a band holding data blocks.

Fields

path: PathBuf

Implementations

impl BlockDir

pub fn new(path: &Path) -> BlockDir

Create a BlockDir accessing path, which must exist as a directory.

pub fn create(path: &Path) -> Result<BlockDir>

Create a BlockDir directory and return an object accessing it.

pub fn store(
    &mut self,
    from_file: &mut dyn Read,
    report: &Report
) -> Result<(Vec<Address>, String)>

Store the contents of a readable file into the BlockDir.

Returns the addresses at which it was stored, plus the hash of the overall original file.

pub fn contains(&self, hash: &str) -> Result<bool>

True if the named block is present in this directory.

pub fn get_block(&self, hash: &str) -> Block

Get an object accessing a whole block. The contents are not yet narrowed down to only the addressed region.

pub fn get(&self, addr: &Address, report: &Report) -> Result<Vec<u8>>

Read back the contents of a block, as a byte array.

To read a whole file, use StoredFile instead.

pub fn block_names(&self, report: &Report) -> Result<Vec<String>>

Return a sorted vec of all the blocknames in the blockdir.

pub fn blocks(&self, report: &Report) -> Result<Vec<Block>>

pub fn validate(&self, report: &Report) -> Result<()>

Check format invariants of the BlockDir; report any problems to the Report.

Trait Implementations

impl Clone for BlockDir

fn clone(&self) -> BlockDir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockDir

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

Formats the value using the given formatter.