Struct Tier

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

Available on crate feature internal only.

A frontier of a tier of the tiered commitment tree, being an 8-deep quad-tree of items.

Implementations

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

where Item::Complete: Clone,

pub fn new(item: Item) -> Self

Create a new tier from a single item which will be its first element.

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 update<T>(&mut self, f: impl FnOnce(&mut Item) -> T) -> Option<T>

Update the focused element of this tier using a function.

If the tier is empty or finalized, the function is not executed, and this returns None.

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

Get the focused element of this tier, if one exists.

If the tier is empty or finalized, returns None.

pub fn is_full(&self) -> bool

Check whether this tier is full.

If this returns false, then insertion will fail.

pub fn finalize(&mut self) -> bool

Finalize this tier so that it is internally marked as complete.

pub fn is_finalized(&self) -> bool

Check whether this tier has been finalized.

Trait Implementations

impl<Item> Clone for Tier<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 Tier<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 Tier<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<Item: Focus + Clone> Focus for Tier<Item>

where Item::Complete: Clone,

type Complete = Tier<<Item as Focus>::Complete>

The Complete of this Frontier.

fn finalize_owned(self) -> Insert<Self::Complete>

Transition from an Frontier to being Complete.

impl<Item: Focus + Forget + Clone> Forget for Tier<Item>

where Item::Complete: ForgetOwned + Clone,

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

Remove the witness for the given index. If a forgotten version is specified, update the path down to the forgotten item to that version plus one.

impl<Item: Focus + Clone> From<Hash> for Tier<Item>

where Item::Complete: Clone,

fn from(hash: Hash) -> Self

Converts to this type from the input type.

impl<Item: Complete + Clone> From<Tier<<Item as Complete>::Focus>> for Insert<Tier<Item>>

where Item::Focus: Clone,

fn from(frontier: Tier<Item::Focus>) -> Self

Converts to this type from the input type.

impl<Item: Focus + Clone> From<Tier<<Item as Focus>::Complete>> for Tier<Item>

where Item::Complete: Clone,

fn from(complete: Tier<Item::Complete>) -> Self

Converts to this type from the input type.

impl<Item: Focus + Clone> From<Top<<Item as Focus>::Complete>> for Tier<Item>

where Item::Complete: Clone,

fn from(complete: Top<Item::Complete>) -> Self

Converts to this type from the input type.

impl<Item: Focus + Clone> GetHash for Tier<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 Tier<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 Tier<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 Tier<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 Tier<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.