Struct BlockNumber 

pub struct BlockNumber(/* private fields */);

A convenience wrapper around a u32 representing the number of a block.

Each block has a unique number and block numbers increase monotonically by 1.

Implementations

impl BlockNumber

pub const EPOCH_LENGTH_EXPONENT: u8 = 16

The length of an epoch expressed as a power of two. 2^(EPOCH_LENGTH_EXPONENT) is the number of blocks in an epoch.

The epoch of a block can be obtained by shifting the block number to the right by this exponent.

pub const GENESIS: Self

The block height of the genesis block.

pub const MAX: Self

The maximum block number.

pub fn parent(self) -> Option<BlockNumber>

Returns the previous block number

pub fn child(self) -> BlockNumber

Returns the next block number

pub const fn from_epoch(epoch: u16) -> BlockNumber

Creates the BlockNumber corresponding to the epoch block for the provided epoch.

pub const fn block_epoch(&self) -> u16

Returns the epoch to which this block number belongs.

pub fn as_u32(&self) -> u32

Returns the block number as a u32.

pub fn as_u64(&self) -> u64

Returns the block number as a u64.

pub fn as_usize(&self) -> usize

Returns the block number as a usize.

pub fn checked_sub(&self, rhs: u32) -> Option<Self>

Checked integer subtraction. Computes self - rhs, returning None if underflow occurred.

pub fn saturating_sub(&self, rhs: u32) -> Self

Saturating integer subtraction. Computes self - rhs, saturating at BlockNumber::GENESIS instead of underflowing.

Trait Implementations

impl Add<u32> for BlockNumber

type Output = BlockNumber

The resulting type after applying the + operator.

fn add(self, other: u32) -> Self::Output

Performs the + operation.

impl Clone for BlockNumber

fn clone(&self) -> BlockNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockNumber

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

Formats the value using the given formatter.

impl Default for BlockNumber

fn default() -> BlockNumber

Returns the “default value” for a type.

impl Deserializable for BlockNumber

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl Display for BlockNumber

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

Formats the value using the given formatter.

impl From<BlockNumber> for Felt

fn from(block_num: BlockNumber) -> Self

Converts to this type from the input type.

impl From<BlockNumber> for NullifierBlock

fn from(block_num: BlockNumber) -> Self

Converts to this type from the input type.

impl From<NullifierBlock> for BlockNumber

fn from(value: NullifierBlock) -> BlockNumber

Converts to this type from the input type.

impl From<u32> for BlockNumber

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for BlockNumber

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 Ord for BlockNumber

fn cmp(&self, other: &BlockNumber) -> 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 BlockNumber

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

fn partial_cmp(&self, other: &BlockNumber) -> 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 Serializable for BlockNumber

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl Copy for BlockNumber

impl Eq for BlockNumber

impl StructuralPartialEq for BlockNumber