Struct grin_core::core::pmmr::segment::SegmentIdentifier

pub struct SegmentIdentifier {
    pub height: u8,
    pub idx: u64,
}

Tuple that defines a segment of a given PMMR

Fields

height: u8

Height of a segment

idx: u64

Zero-based index of the segment

Implementations

impl SegmentIdentifier

pub fn traversal_iter( target_mmr_size: u64, segment_height: u8 ) -> impl Iterator<Item = SegmentIdentifier>

Test helper to get an iterator of SegmentIdentifiers required to read a pmmr of size target_mmr_size in segments of height segment_height

pub fn count_segments_required( target_mmr_size: u64, segment_height: u8 ) -> usize

Returns number of segments required that would needed in order to read a pmmr of size target_mmr_size in segments of height segment_height

pub fn pmmr_size(num_segments: usize, height: u8) -> u64

Return pmmr size of number of segments of the given height

pub fn segment_capacity(&self) -> u64

Maximum number of leaves in a segment, given by 2**height

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

Inclusive (full) range of MMR positions for the segment that would be produced by this Identifier

Trait Implementations

impl Clone for SegmentIdentifier

fn clone(&self) -> SegmentIdentifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SegmentIdentifier

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

Formats the value using the given formatter.

impl PartialEq for SegmentIdentifier

fn eq(&self, other: &SegmentIdentifier) -> 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 Readable for SegmentIdentifier

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

Reads the data necessary to this Readable from the provided reader

impl Writeable for SegmentIdentifier

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

Write the data held by this Writeable to the provided writer

impl Copy for SegmentIdentifier

impl Eq for SegmentIdentifier

impl StructuralPartialEq for SegmentIdentifier