Struct grin_core::core::pmmr::segment::Segment

pub struct Segment<T> { /* private fields */ }

Segment of a PMMR: unpruned leaves and the necessary data to verify segment membership in the original MMR.

Implementations

impl<T> Segment<T>

pub fn segment_pos_range(&self, mmr_size: u64) -> (u64, u64)

Inclusive range of MMR positions for this segment

pub fn identifier(&self) -> SegmentIdentifier

Get the identifier associated with this segment

pub fn parts( self ) -> (SegmentIdentifier, Vec<u64>, Vec<Hash>, Vec<u64>, Vec<T>, SegmentProof)

Consume the segment and return its parts

pub fn from_parts( identifier: SegmentIdentifier, hash_pos: Vec<u64>, hashes: Vec<Hash>, leaf_pos: Vec<u64>, leaf_data: Vec<T>, proof: SegmentProof ) -> Self

Construct a segment from its parts

pub fn leaf_iter(&self) -> impl Iterator<Item = (u64, &T)> + '_

Iterator of all the leaves in the segment

pub fn hash_iter(&self) -> impl Iterator<Item = (u64, Hash)> + '_

Iterator of all the hashes in the segment

pub fn proof(&self) -> &SegmentProof

Segment proof

pub fn id(&self) -> SegmentIdentifier

Segment identifier

impl<T> Segment<T>

where T: Readable + Writeable + Debug,

pub fn from_pmmr<U, B>( segment_id: SegmentIdentifier, pmmr: &ReadonlyPMMR<'_, U, B>, prunable: bool ) -> Result<Self, SegmentError>

where U: PMMRable<E = T>, B: Backend<U>,

Generate a segment from a PMMR

impl<T> Segment<T>

where T: PMMRIndexHashable,

pub fn root( &self, mmr_size: u64, bitmap: Option<&Bitmap> ) -> Result<Option<Hash>, SegmentError>

Calculate root hash of this segment Returns None iff the segment is full and completely pruned

pub fn first_unpruned_parent( &self, mmr_size: u64, bitmap: Option<&Bitmap> ) -> Result<(Hash, u64), SegmentError>

Get the first 1-based (sucks) unpruned parent hash of this segment

pub fn validate( &self, mmr_size: u64, bitmap: Option<&Bitmap>, mmr_root: Hash ) -> Result<(), SegmentError>

Check validity of the segment by calculating its root and validating the merkle proof

pub fn validate_with( &self, mmr_size: u64, bitmap: Option<&Bitmap>, mmr_root: Hash, hash_last_pos: u64, other_root: Hash, other_is_left: bool ) -> Result<(), SegmentError>

Check validity of the segment by calculating its root and validating the merkle proof This function assumes a final hashing step together with other_root

Trait Implementations

impl<T: Clone> Clone for Segment<T>

fn clone(&self) -> Segment<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Segment<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Segment<T>

fn eq(&self, other: &Segment<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Readable> Readable for Segment<T>

fn read<R: Reader>(reader: &mut R) -> Result<Self, Error>

Reads the data necessary to this Readable from the provided reader

impl<T: Writeable> Writeable for Segment<T>

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Write the data held by this Writeable to the provided writer

impl<T: Eq> Eq for Segment<T>

impl<T> StructuralPartialEq for Segment<T>