Struct BlockInterval

pub struct BlockInterval(pub u32);

Available on crate feature alloc only.

The block interval.

Block interval is an integer type denoting the number of blocks that has passed since some point i.e., this type is meant for usage as a relative block measure.

This type is not meant for constructing relative height based timelocks, this is a general purpose block interval abstraction. For locktimes please see locktime::relative::Height.

Tuple Fields

0: u32

Implementations

impl BlockInterval

pub const ZERO: Self = _

Block interval 0 i.e., the current block.

pub const MIN: Self = Self::ZERO

The minimum block interval (0).

pub const MAX: Self = _

The maximum block interval.

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

Creates a block interval from a u32.

pub const fn to_u32(&self) -> u32

Returns block interval as a u32.

Trait Implementations

impl Add<BlockInterval> for BlockHeight

type Output = BlockHeight

The resulting type after applying the + operator.

fn add(self, rhs: BlockInterval) -> Self::Output

Performs the + operation.

impl Add for BlockInterval

type Output = BlockInterval

The resulting type after applying the + operator.

fn add(self, rhs: BlockInterval) -> Self::Output

Performs the + operation.

impl AddAssign for BlockInterval

fn add_assign(&mut self, rhs: BlockInterval)

Performs the += operation.

impl Clone for BlockInterval

fn clone(&self) -> BlockInterval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockInterval

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockInterval

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockInterval

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

Formats the value using the given formatter.

impl From<BlockInterval> for u32

fn from(height: BlockInterval) -> Self

Converts to this type from the input type.

impl From<Height> for BlockInterval

fn from(h: Height) -> Self

Converts a locktime::relative::Height to a BlockInterval.

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

impl From<u32> for BlockInterval

fn from(inner: u32) -> Self

Converts to this type from the input type.

impl FromStr for BlockInterval

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 BlockInterval

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 BlockInterval

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<BlockInterval> for BlockHeight

type Output = BlockHeight

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for BlockInterval

type Output = BlockInterval

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for BlockInterval

fn sub_assign(&mut self, rhs: BlockInterval)

Performs the -= operation.

impl TryFrom<&str> for BlockInterval

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<BlockInterval> for Height

fn try_from(h: BlockInterval) -> Result<Self, Self::Error>

Converts a BlockInterval to a locktime::relative::Height.

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

type Error = TooBigForRelativeBlockHeightError

The type returned in the event of a conversion error.

impl TryFrom<Box<str>> for BlockInterval

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from(s: Box<str>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for BlockInterval

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for BlockInterval

impl Eq for BlockInterval

impl StructuralPartialEq for BlockInterval