Struct LeavesToRootValidator 

pub struct LeavesToRootValidator {
    accepted_directories: HashMap<B3Digest, u64>,
    pending_directories: HashSet<B3Digest>,
    last_inserted_digest: Option<B3Digest>,
    poison: bool,
}

A struct holding state while consuming a sequence of Directories in Leaves-To-Root order.

Validates that newly accepted directories only reference directories which have already been accepted before, and that the sizes attached alongside the pointers match the actual sizes. Commonly used when uploading a directory closure to a store.

Fields

accepted_directories: HashMap<B3Digest, u64>

tracks inserted directories, and their sizes observed.

pending_directories: HashSet<B3Digest>

tracks seen directories which are not yet referenced by parents. (root candidates)

last_inserted_digest: Option<B3Digest>

Tracks the last received digest

poison: bool

tracks whether Self::finalize has been called, or an error has occured while trying to accept.

Implementations

impl LeavesToRootValidator

pub fn new() -> Self

pub fn try_accept(&mut self, directory: &Directory) -> Result<(), OrderingError>

Accepts a directory if previously introduced, or returns an error if it’s unknown.

pub fn finalize(self) -> Result<(), OrderingError>

Should be called before Drop, to ensure there’s no introduced but unsent directories.

pub fn validate_stream<'s, S>( directories: S, ) -> BoxStream<'s, Result<Directory, OrderingError>>

where S: Stream<Item = Directory> + Send + 's,

This receives a stream of Directories, validating them to be in Leaves-To-Root order. If the order is correct, they are yielded wrapped in an Ok(). If not, we yield an error.

Trait Implementations

impl Default for LeavesToRootValidator

fn default() -> LeavesToRootValidator

Returns the “default value” for a type.