Trait penumbra_tct::internal::complete::ForgetOwned

source · 
pub trait ForgetOwned: Height + Sized {
    // Required method
    fn forget_owned(
        self,
        forgotten: Option<Forgotten>,
        index: impl Into<u64>
    ) -> (Insert<Self>, bool);
}
Available on crate feature internal only.
Expand description

Forget about the authentication path to a given index, when forgetting can turn the entirety of Self into a hash.

Required Methods§

source

fn forget_owned( self, forgotten: Option<Forgotten>, index: impl Into<u64> ) -> (Insert<Self>, bool)

Remove the witness for the given index and summarize the item as a single Hash if it now contains no more witnesses. If a forgotten version is specified, update the path down to the forgotten item to that version plus one.

Returns either (Self, boool) where the boolean is true if the witness was removed or false if the witness was not present, or Hash if the witness was removed and it was the last witness remaining in this tree.

Object Safety§

This trait is not object safe.

Implementors§