Struct LeavesToRoot 

pub struct LeavesToRoot {
    accepted_directories: HashMap<B3Digest, RangeInclusive<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, RangeInclusive<u64>>

Available on crate feature compat-accept-bigger-sizes only.

tracks inserted directories, and their sizes observed. size is tracked as a range, as this could be a closure with legacy sizes.

pending_directories: HashSet<B3Digest>

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

last_inserted_digest: Option<B3Digest>

Available on debug-assertions enabled only.

Tracks the last received digest

poison: bool

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

Implementations

impl LeavesToRoot

pub fn new() -> Self

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 LeavesToRoot

fn default() -> LeavesToRoot

Returns the “default value” for a type.

impl OrderValidator for LeavesToRoot

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

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

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

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