Struct conserve::BlockDir

pub struct BlockDir { /* private fields */ }

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

Implementations

impl BlockDir

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

pub fn open(transport: Box<dyn Transport>) -> BlockDir

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

Create a BlockDir directory and return an object accessing it.

pub fn create(transport: Box<dyn Transport>) -> Result<BlockDir>

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

True if the named block is present in this directory.

pub fn compressed_size(&self, hash: &BlockHash) -> Result<u64>

Returns the compressed on-disk size of a block.

pub fn get(&self, address: &Address) -> Result<(Vec<u8>, Sizes)>

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

To read a whole file, use StoredFile instead.

pub fn delete_block(&self, hash: &BlockHash) -> Result<()>

pub fn block_names(&self) -> Result<impl Iterator<Item = BlockHash>>

Return all the blocknames in the blockdir, in arbitrary order.

pub fn block_names_set(&self) -> Result<HashSet<BlockHash>>

Return all the blocknames in the blockdir.

pub fn validate(
    &self,
    stats: &mut ValidateStats
) -> Result<HashMap<BlockHash, usize>>

Check format invariants of the BlockDir.

Return a dict describing which blocks are present, and the length of their uncompressed data.

pub fn get_block_content(&self, hash: &BlockHash) -> Result<(Vec<u8>, Sizes)>

Return the entire contents of the block.

Checks that the hash is correct with the contents.

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.