Struct btlib::crypto::merkle_stream::VecMerkleTree

pub struct VecMerkleTree<T> { /* private fields */ }

An implementation of a Merkle tree, a tree for storing hashes. This implementation is a binary tree which stores its nodes in a vector to ensure data locality.

This type is used to provide integrity protection to a sequence of fixed sized units of data called sectors. The size of the sectors are determined when the tree is created and cannot be changed later. The hashes contained in the leaf nodes of this tree are hashes of sectors. Each sector corresponds to an offset into the protected data, and in order to verify that a sector has not been modified, you must supply the offset of the sector.

Implementations

impl<T> VecMerkleTree<T>

pub fn empty(sector_sz: usize) -> VecMerkleTree<T>

Creates a new tree with no nodes in it and the given sector size.

Trait Implementations

impl<T> Default for VecMerkleTree<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for VecMerkleTree<T>where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: MerkleNode> MerkleTree for VecMerkleTree<T>

fn verify(&self, offset: usize, data: &[u8]) -> Result<()>

Verifies that the given data stored from the given offset into the protected data, has not been modified.

fn assert_root_contains(&mut self, hash_data: Option<&[u8]>) -> Result<()>

Checks that the root node contains the given hash data. If it does then Ok(()) is returned. If it doesn’t, then Err(Error::HashCmpFailure) is returned.

fn write(&mut self, offset: usize, data: &[u8]) -> Result<()>

Hashes the given data, adds a new node to the tree with its hash and updates the hashes of all parent nodes.

fn root_hash(&self) -> Result<&[u8]>

Returns the hash data stored in the root node of the tree. An error is returned if and only if the tree is empty.

impl<T> Sectored for VecMerkleTree<T>

fn sector_sz(&self) -> usize

Returns the size of the sector for this stream.

fn sector_sz64(&self) -> u64

Returns the sector size as a u64.

fn assert_sector_sz(&self, actual: usize) -> Result<()>

Returns Err(Error::IncorrectSize) if the given size is not equal to the sector size.

fn assert_at_least_sector_sz(&self, actual: usize) -> Result<()>

Returns Err(Error::IncorrectSize) if the given size is less than the sector size.

fn offset_at(&self, index: u64) -> u64

Returns the offset (in bytes) from the beginning of this stream that the given 0-based sector index corresponds to.

impl<T> Serialize for VecMerkleTree<T>where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.