Struct BlockHeight 

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

A block height (equivalently: consensus slot / report round), in blocks.

Implementations

impl BlockHeight

pub const ZERO: Self

Genesis / zero height.

pub const MAX: Self

The largest representable height.

pub const BORSH_SERIALIZED_SIZE: usize

The size of a borsh-serialized BlockHeight (identical to u64).

pub const fn new(height: u64) -> Self

Wraps a raw block height.

pub const fn as_u64(self) -> u64

Returns the height as a u64.

pub const fn to_le_bytes(self) -> [u8; 8]

Returns the height as little-endian bytes.

pub const fn from_le_bytes(bytes: [u8; 8]) -> Self

Constructs from little-endian height bytes.

pub const fn saturating_add(self, n: u64) -> Self

Returns the height n blocks later, saturating at BlockHeight::MAX.

pub const fn saturating_sub(self, n: u64) -> Self

Returns the height n blocks earlier, saturating at BlockHeight::ZERO.

Trait Implementations

impl BorshDeserialize for BlockHeight

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

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

where R: Read,

impl BorshSerialize for BlockHeight

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for BlockHeight

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BlockHeight

impl Debug for BlockHeight

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

Formats the value using the given formatter.

impl Default for BlockHeight

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BlockHeight

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockHeight

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

Formats the value using the given formatter.

impl Eq for BlockHeight

impl FromStr for BlockHeight

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for BlockHeight

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 BlockHeight

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BlockHeight

fn partial_cmp(&self, other: &Self) -> 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 Serialize for BlockHeight

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BlockHeight