Struct Top

pub struct Top<Item: Focus + Clone>
where
    Item::Complete: Clone,
{ /* private fields */ }

Available on crate feature internal only.

The frontier of the top level of some part of the commitment tree, which may be empty, but may not be finalized or hashed.

Implementations

impl<Item: Focus + Clone> Top<Item>

where Item::Complete: Clone,

pub fn new(track_forgotten: TrackForgotten) -> Self

Create a new top-level frontier tier.

pub fn insert(&mut self, item: Item) -> Result<(), Item>

Insert an item or its hash into this frontier tier.

If the tier is full, return the input item without inserting it.

pub fn forget(&mut self, index: impl Into<u64>) -> bool

where Item: Forget, Item::Complete: ForgetOwned,

Forgot the commitment at the given index.

This isn’t an implementation of Forget because unlike Forget, this doesn’t require an input forgotten version, since it calculates it based on the forgotten versions at this top level.

pub fn forgotten(&self) -> Option<Forgotten>

Count the number of times something has been forgotten from this tree.

pub fn update<T>(&mut self, f: impl FnOnce(&mut Item) -> T) -> Option<T>

Update the currently focused Item (i.e. the most-recently-inserted one), returning the result of the function.

If this top-level tier is empty or the most recently inserted item is a hash, returns None.

pub fn focus(&self) -> Option<&Item>

Get a reference to the focused Insert<Item>, if there is one.

If this top-level tier is empty or the focus is a hash, returns None.

pub fn finalize(self) -> Insert<Top<Item::Complete>>

Finalize the top tier into either a summary root hash or a complete tier.

pub fn is_full(&self) -> bool

Check whether this top-level tier is full.

pub fn is_empty(&self) -> bool

Check whether this top-level tier is empty.

Trait Implementations

impl<Item> Clone for Top<Item>

where Item::Complete: Clone, Item: Clone + Focus,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Item> Debug for Top<Item>

where Item::Complete: Clone + Debug, Item: Debug + Focus + Clone,

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

Formats the value using the given formatter.

impl<'de, Item> Deserialize<'de> for Top<Item>

where Item::Complete: Clone + Deserialize<'de>, Item: Deserialize<'de> + Focus + Clone,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Top<Tier<Tier<Item>>>> for Tree

fn from(inner: Top<Tier<Tier<Item>>>) -> Self

Converts to this type from the input type.

impl<Item: Focus + Clone> GetHash for Top<Item>

where Item::Complete: Clone,

fn hash(&self) -> Hash

Get the hash of this item.

fn cached_hash(&self) -> Option<Hash>

Get the hash of this item, only if the hash is already cached and does not require recalculation.

fn clear_cached_hash(&self)

If there is a hash cached, clear the cache.

impl<Item: Focus + GetPosition + Clone> GetPosition for Top<Item>

where Item::Complete: Clone,

fn position(&self) -> Option<u64>

The position of the next insertion into the tree.

impl<Item: Focus + Clone> Height for Top<Item>

where Item::Complete: Clone,

type Height = <Node<Node<Node<Node<Node<Node<Node<Node<Leaf<Item>>>>>>>>> as Height>::Height

The height of this type above the leaves of the tree.

impl<Item> Serialize for Top<Item>

where Item::Complete: Clone + Serialize, Item: Serialize + Focus + Clone,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Item: Focus + Witness + Clone> Witness for Top<Item>

where Item::Complete: Witness + Clone,

fn witness(&self, index: impl Into<u64>) -> Option<(AuthPath<Self>, Hash)>

Witness an authentication path to the given index in the tree.