Struct BlockHeightInterval 

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

An unsigned block interval.

Block interval is an integer type representing a difference between the heights of two blocks.

This type is not meant for constructing relative height based timelocks. It is a general purpose block interval abstraction. For locktimes please see [locktime::relative::NumberOfBlocks].

Implementations

impl BlockHeightInterval

pub const ZERO: BlockHeightInterval

Block interval 0.

pub const MIN: BlockHeightInterval = Self::ZERO

The minimum block interval, equivalent to Self::ZERO.

pub const MAX: BlockHeightInterval

The maximum block interval.

pub const fn from_u32(inner: u32) -> BlockHeightInterval

Constructs a new block interval from a u32.

pub const fn to_u32(self) -> u32

Returns block interval as a u32.

pub fn checked_sub( self, other: BlockHeightInterval, ) -> Option<BlockHeightInterval>

Attempt to subtract two BlockHeightIntervals, returning None if overflow occurred.

pub fn checked_add( self, other: BlockHeightInterval, ) -> Option<BlockHeightInterval>

Attempt to add two BlockHeightIntervals, returning None if overflow occurred.

Trait Implementations

impl<'a> Add<&'a BlockHeightInterval> for &BlockHeight

type Output = <BlockHeight as Add<BlockHeightInterval>>::Output

The resulting type after applying the + operator.

fn add( self, rhs: &BlockHeightInterval, ) -> <&BlockHeight as Add<&'a BlockHeightInterval>>::Output

Performs the + operation.

impl<'a> Add<&'a BlockHeightInterval> for &BlockHeightInterval

type Output = <BlockHeightInterval as Add>::Output

The resulting type after applying the + operator.

fn add( self, rhs: &BlockHeightInterval, ) -> <&BlockHeightInterval as Add<&'a BlockHeightInterval>>::Output

Performs the + operation.

impl Add<&BlockHeightInterval> for BlockHeight

type Output = <BlockHeight as Add<BlockHeightInterval>>::Output

The resulting type after applying the + operator.

fn add( self, rhs: &BlockHeightInterval, ) -> <BlockHeight as Add<&BlockHeightInterval>>::Output

Performs the + operation.

impl Add<&BlockHeightInterval> for BlockHeightInterval

type Output = <BlockHeightInterval as Add>::Output

The resulting type after applying the + operator.

fn add( self, rhs: &BlockHeightInterval, ) -> <BlockHeightInterval as Add<&BlockHeightInterval>>::Output

Performs the + operation.

impl Add<BlockHeightInterval> for &BlockHeight

type Output = <BlockHeight as Add<BlockHeightInterval>>::Output

The resulting type after applying the + operator.

fn add( self, rhs: BlockHeightInterval, ) -> <&BlockHeight as Add<BlockHeightInterval>>::Output

Performs the + operation.

impl Add<BlockHeightInterval> for &BlockHeightInterval

type Output = <BlockHeightInterval as Add>::Output

The resulting type after applying the + operator.

fn add( self, rhs: BlockHeightInterval, ) -> <&BlockHeightInterval as Add<BlockHeightInterval>>::Output

Performs the + operation.

impl Add<BlockHeightInterval> for BlockHeight

type Output = BlockHeight

The resulting type after applying the + operator.

fn add( self, rhs: BlockHeightInterval, ) -> <BlockHeight as Add<BlockHeightInterval>>::Output

Performs the + operation.

impl Add for BlockHeightInterval

type Output = BlockHeightInterval

The resulting type after applying the + operator.

fn add(self, rhs: BlockHeightInterval) -> <BlockHeightInterval as Add>::Output

Performs the + operation.

impl AddAssign<&BlockHeightInterval> for BlockHeightInterval

fn add_assign(&mut self, rhs: &BlockHeightInterval)

Performs the += operation.

impl AddAssign for BlockHeightInterval

fn add_assign(&mut self, rhs: BlockHeightInterval)

Performs the += operation.

impl<'a> Arbitrary<'a> for BlockHeightInterval

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<BlockHeightInterval, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Binary for BlockHeightInterval

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

Formats the value using the given formatter.

impl Clone for BlockHeightInterval

fn clone(&self) -> BlockHeightInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockHeightInterval

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

Formats the value using the given formatter.

impl Default for BlockHeightInterval

fn default() -> BlockHeightInterval

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BlockHeightInterval

Available on crate feature serde only.

fn deserialize<D>( d: D, ) -> Result<BlockHeightInterval, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockHeightInterval

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

Formats the value using the given formatter.

impl From<BlockHeightInterval> for u32

fn from(height: BlockHeightInterval) -> u32

Converts to this type from the input type.

impl From<NumberOfBlocks> for BlockHeightInterval

fn from(h: NumberOfBlocks) -> BlockHeightInterval

Converts a [locktime::relative::NumberOfBlocks] to a BlockHeightInterval.

A relative locktime block height has a maximum value of u16::MAX where as a BlockHeightInterval is a thin wrapper around a u32, the two types are not interchangeable.

impl From<u32> for BlockHeightInterval

fn from(inner: u32) -> BlockHeightInterval

Converts to this type from the input type.

impl FromStr for BlockHeightInterval

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<BlockHeightInterval, <BlockHeightInterval as FromStr>::Err>

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

impl Hash for BlockHeightInterval

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 LowerHex for BlockHeightInterval

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

Formats the value using the given formatter.

impl Octal for BlockHeightInterval

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

Formats the value using the given formatter.

impl Ord for BlockHeightInterval

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

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

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

Available on crate feature serde only.

fn serialize<S>( &self, s: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Sub<&'a BlockHeightInterval> for &BlockHeight

type Output = <BlockHeight as Sub<BlockHeightInterval>>::Output

The resulting type after applying the - operator.

fn sub( self, rhs: &BlockHeightInterval, ) -> <&BlockHeight as Sub<&'a BlockHeightInterval>>::Output

Performs the - operation.

impl<'a> Sub<&'a BlockHeightInterval> for &BlockHeightInterval

type Output = <BlockHeightInterval as Sub>::Output

The resulting type after applying the - operator.

fn sub( self, rhs: &BlockHeightInterval, ) -> <&BlockHeightInterval as Sub<&'a BlockHeightInterval>>::Output

Performs the - operation.

impl Sub<&BlockHeightInterval> for BlockHeight

type Output = <BlockHeight as Sub<BlockHeightInterval>>::Output

The resulting type after applying the - operator.

fn sub( self, rhs: &BlockHeightInterval, ) -> <BlockHeight as Sub<&BlockHeightInterval>>::Output

Performs the - operation.

impl Sub<&BlockHeightInterval> for BlockHeightInterval

type Output = <BlockHeightInterval as Sub>::Output

The resulting type after applying the - operator.

fn sub( self, rhs: &BlockHeightInterval, ) -> <BlockHeightInterval as Sub<&BlockHeightInterval>>::Output

Performs the - operation.

impl Sub<BlockHeightInterval> for &BlockHeight

type Output = <BlockHeight as Sub<BlockHeightInterval>>::Output

The resulting type after applying the - operator.

fn sub( self, rhs: BlockHeightInterval, ) -> <&BlockHeight as Sub<BlockHeightInterval>>::Output

Performs the - operation.

impl Sub<BlockHeightInterval> for &BlockHeightInterval

type Output = <BlockHeightInterval as Sub>::Output

The resulting type after applying the - operator.

fn sub( self, rhs: BlockHeightInterval, ) -> <&BlockHeightInterval as Sub<BlockHeightInterval>>::Output

Performs the - operation.

impl Sub<BlockHeightInterval> for BlockHeight

type Output = BlockHeight

The resulting type after applying the - operator.

fn sub( self, rhs: BlockHeightInterval, ) -> <BlockHeight as Sub<BlockHeightInterval>>::Output

Performs the - operation.

impl Sub for BlockHeightInterval

type Output = BlockHeightInterval

The resulting type after applying the - operator.

fn sub(self, rhs: BlockHeightInterval) -> <BlockHeightInterval as Sub>::Output

Performs the - operation.

impl SubAssign<&BlockHeightInterval> for BlockHeightInterval

fn sub_assign(&mut self, rhs: &BlockHeightInterval)

Performs the -= operation.

impl SubAssign for BlockHeightInterval

fn sub_assign(&mut self, rhs: BlockHeightInterval)

Performs the -= operation.

impl<'a> Sum<&'a BlockHeightInterval> for BlockHeightInterval

fn sum<I>(iter: I) -> BlockHeightInterval

where I: Iterator<Item = &'a BlockHeightInterval>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for BlockHeightInterval

fn sum<I>(iter: I) -> BlockHeightInterval

where I: Iterator<Item = BlockHeightInterval>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<&str> for BlockHeightInterval

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<BlockHeightInterval, <BlockHeightInterval as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<BlockHeightInterval> for NumberOfBlocks

fn try_from( h: BlockHeightInterval, ) -> Result<NumberOfBlocks, <NumberOfBlocks as TryFrom<BlockHeightInterval>>::Error>

Converts a BlockHeightInterval to a [locktime::relative::NumberOfBlocks].

A relative locktime block height has a maximum value of u16::MAX where as a BlockHeightInterval is a thin wrapper around a u32, the two types are not interchangeable.

type Error = TooBigForRelativeHeightError

The type returned in the event of a conversion error.

impl TryFrom<Box<str>> for BlockHeightInterval

Available on crate feature alloc only.

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from( s: Box<str>, ) -> Result<BlockHeightInterval, <BlockHeightInterval as TryFrom<Box<str>>>::Error>

Performs the conversion.

impl TryFrom<String> for BlockHeightInterval

Available on crate feature alloc only.

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from( s: String, ) -> Result<BlockHeightInterval, <BlockHeightInterval as TryFrom<String>>::Error>

Performs the conversion.

impl UpperHex for BlockHeightInterval

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

Formats the value using the given formatter.

impl Copy for BlockHeightInterval

impl Eq for BlockHeightInterval

impl StructuralPartialEq for BlockHeightInterval