Struct zebra_chain::block::height::Height

pub struct Height(pub u32);

The length of the chain back to the genesis block.

Two Heights can’t be added, but they can be subtracted to get their difference, represented as an HeightDiff. This difference can then be added to or subtracted from a Height. Note the similarity with chrono::DateTime and chrono::Duration.

Invariants

Users should not construct block heights greater than Height::MAX.

Consensus

There are multiple formats for serializing a height, so we don’t implement ZcashSerialize or ZcashDeserialize for Height.

Tuple Fields

0: u32

Implementations

impl Height

pub const MIN: Height = _

The minimum Height.

Due to the underlying type, it is impossible to construct block heights less than Height::MIN.

Style note: Sometimes, Height::MIN is less readable than Height(0). Use whichever makes sense in context.

pub const MAX: Height = _

The maximum Height.

Users should not construct block heights greater than Height::MAX.

The spec says “Implementations MUST support block heights up to and including 2^31 − 1”.

Note that u32::MAX / 2 == 2^31 - 1 == i32::MAX.

pub const MAX_AS_U32: u32 = 2_147_483_647u32

The maximum Height as a u32, for range patterns.

Height::MAX.0 can’t be used in match range patterns, use this alias instead.

pub const MAX_EXPIRY_HEIGHT: Height = _

The maximum expiration Height that is allowed in all transactions previous to Nu5 and in non-coinbase transactions from Nu5 activation height and above.

impl Height

pub fn coinbase_zcash_serialized_size(&self) -> usize

Get the size of Height when serialized into a coinbase input script.

Trait Implementations

impl Add<i64> for Height

fn add(self, rhs: HeightDiff) -> Option<Height>

Add a height difference to a height, returning None if the resulting height is outside the valid Height range (this also checks the result is non-negative).

type Output = Option<Height>

The resulting type after applying the + operator.

impl Arbitrary for Height

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

fn arbitrary_with(_args: ()) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

type Strategy = BoxedStrategy<Height>

The type of Strategy used to generate values of type Self.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for Height

fn clone(&self) -> Height

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Height

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Height

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Height

type Err = SerializationError

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 Height

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 Height

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Height> for Height

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<Height> for Height

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Height

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

Serialize this value into the given Serde serializer.

impl Sub<Height> for Height

fn sub(self, rhs: Height) -> Self::Output

Subtract two heights, returning the result, which can be negative. Since HeightDiff is i64 and Height is u32, the result is always correct.

type Output = i64

The resulting type after applying the - operator.

impl Sub<i64> for Height

fn sub(self, rhs: HeightDiff) -> Option<Self>

Subtract a height difference from a height, returning None if the resulting height is outside the valid Height range (this also checks the result is non-negative).

type Output = Option<Height>

The resulting type after applying the - operator.

impl TryFrom<u32> for Height

fn try_from(height: u32) -> Result<Self, Self::Error>

Checks that the height is within the valid Height range.

type Error = &'static str

The type returned in the event of a conversion error.

impl Copy for Height

impl Eq for Height

impl StructuralEq for Height

impl StructuralPartialEq for Height