Struct BlockNumber 

pub struct BlockNumber { /* private fields */ }

A block height in the chain.

Block numbers compare as integers and are bounded to u32 by the protocol. Kernel-returned heights are trusted; raw felts (e.g. read from note storage) convert via the validated TryFrom<Felt> implementation.

Implementations

impl BlockNumber

pub fn as_u32(&self) -> u32

Returns the block number as a u32 value.

Panics

Panics if the wrapped felt exceeds the maximum block height (possible only for values that bypassed validation, e.g. a WIT record lifted from a raw felt).

pub fn as_felt(&self) -> Felt

Returns the block number as a raw Felt for advanced use.

Trait Implementations

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

impl Debug for BlockNumber

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

Formats the value using the given formatter.

impl Eq for BlockNumber

impl From<BlockNumber> for Felt

fn from(value: BlockNumber) -> Self

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for BlockNumber

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

Equality operator ==.

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

Inequality operator !=.

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

impl TryFrom<Felt> for BlockNumber

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: Felt) -> Result<Self, Self::Error>

Performs the conversion.