Struct Index

#[repr(transparent)]
pub struct Index(u32);

A tagged block index (MSB = chain status, lower 31 bits = position in the header file).

• If MSB = 0, the block is in the main chain. In this case, the index is equal to the block height, as we store mainchain headers with canonical order.
• If MSB = 1, the block is in a fork chain. In this case, the index is different from the height, as we store fork headers (in the fork file) in the order they are found.

Tuple Fields

0: u32

Implementations

impl Index

const FORK_BIT: u32 = 2_147_483_648u32

Mask for the MSB

const INDEX_MASK: u32 = 2_147_483_647u32

Mask for the 31 lower bits

pub fn new(index: u32) -> Result<Self, FlatChainstoreError>

Create a new mainchain entry (MSB is zero)

pub fn new_fork(index: u32) -> Result<Self, FlatChainstoreError>

Create a new fork entry (MSB is set)

pub fn is_main_chain(&self) -> bool

Tells if this is a block in our main chain

pub fn index(&self) -> u32

Takes only the integer height of the block, without the tag

pub fn is_empty(&self) -> bool

Tells if this is an empty position (i.e., we haven’t written anything here yet, or this is the mainchain genesis index)

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Ord for Index

fn cmp(&self, other: &Index) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Index

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

fn partial_cmp(&self, other: &Index) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Index

impl Eq for Index

impl StructuralPartialEq for Index