Struct SegmentHeader 

pub struct SegmentHeader { /* private fields */ }

A segment header that contains information common to all segments. Used for storage.

Implementations

impl SegmentHeader

pub const fn new( expected_block_range: SegmentRangeInclusive, block_range: Option<SegmentRangeInclusive>, tx_range: Option<SegmentRangeInclusive>, segment: StaticFileSegment, ) -> Self

Returns SegmentHeader.

pub const fn segment(&self) -> StaticFileSegment

Returns the static file segment kind.

pub const fn expected_block_range(&self) -> SegmentRangeInclusive

Returns the expected block range.

pub const fn block_range(&self) -> Option<SegmentRangeInclusive>

Returns the block range.

pub const fn tx_range(&self) -> Option<SegmentRangeInclusive>

Returns the transaction range.

pub const fn changeset_offsets_len(&self) -> u64

Returns the number of changeset offset entries. The actual offsets are stored in the .csoff sidecar file.

pub const fn set_changeset_offsets_len(&mut self, len: u64)

Sets the changeset offsets length.

pub const fn increment_changeset_offsets_len(&mut self)

Increments the changeset offsets length by 1.

pub const fn expected_block_start(&self) -> BlockNumber

The expected block start of the segment.

pub const fn set_expected_block_start(&mut self, block: BlockNumber)

Sets the expected block start of the segment, using the file boundary end from find_fixed_range.

This is useful for non-zero genesis blocks where the actual starting block differs from the file range start determined by find_fixed_range. For example, if blocks_per_file is 500 and genesis is at 502, the range becomes 502..=999 (start at genesis, end at file boundary).

pub const fn expected_block_end(&self) -> BlockNumber

The expected block end of the segment.

pub fn block_start(&self) -> Option<BlockNumber>

Returns the first block number of the segment.

pub fn block_end(&self) -> Option<BlockNumber>

Returns the last block number of the segment.

pub fn tx_start(&self) -> Option<TxNumber>

Returns the first transaction number of the segment.

pub fn tx_end(&self) -> Option<TxNumber>

Returns the last transaction number of the segment.

pub fn tx_len(&self) -> Option<u64>

Number of transactions.

pub fn block_len(&self) -> Option<u64>

Number of blocks.

pub const fn increment_block(&mut self) -> BlockNumber

Increments block end range depending on segment

pub const fn increment_tx(&mut self)

Increments tx end range depending on segment

pub const fn prune(&mut self, num: u64)

Removes num elements from end of tx or block range.

For changeset segments, also decrements the changeset offsets length. The caller must truncate the sidecar file accordingly.

pub const fn set_block_range( &mut self, block_start: BlockNumber, block_end: BlockNumber, )

Sets a new block_range.

pub const fn sync_changeset_offsets(&mut self)

Synchronizes changeset offsets length with the current block range for changeset segments.

This should be called after modifying the block range when dealing with changeset segments to ensure the offsets length matches the block range size. The caller must also truncate the sidecar file accordingly.

pub const fn set_tx_range(&mut self, tx_start: TxNumber, tx_end: TxNumber)

Sets a new tx_range.

pub fn start(&self) -> Option<u64>

Returns the row offset which depends on whether the segment is block or transaction based.

pub fn changeset_offset_index(&self, block: BlockNumber) -> Option<u64>

Returns the index into the sidecar file for a given block’s changeset offset.

Returns None if the block is not in the block range. To get the changeset offset, the caller must read the offset from the sidecar file at this index.

Trait Implementations

impl Clone for SegmentHeader

fn clone(&self) -> SegmentHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SegmentHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SegmentHeader

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SegmentHeader

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SegmentHeader

fn eq(&self, other: &SegmentHeader) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SegmentHeader

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SegmentHeader

impl StructuralPartialEq for SegmentHeader

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 80 bytes