Struct BlockMtpInterval 

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

An unsigned difference between two BlockMtps.

This type is not meant for constructing time-based timelocks. It is a general purpose MTP abstraction. For locktimes please see [locktime::relative::NumberOf512Seconds].

This is a thin wrapper around a u32 that may take on all values of a u32.

Implementations

impl BlockMtpInterval

pub fn from_hex(s: &str) -> Result<BlockMtpInterval, PrefixedHexError>

Constructs a new BlockMtpInterval from an unprefixed hex string.

Errors

If the input string is not a valid hex representation of a BlockMtpInterval or it does not include the 0x prefix.

pub fn from_unprefixed_hex( s: &str, ) -> Result<BlockMtpInterval, UnprefixedHexError>

Constructs a new BlockMtpInterval from a prefixed hex string.

Errors

If the input string is not a valid hex representation of a BlockMtpInterval or if it includes the 0x prefix.

impl BlockMtpInterval

pub const ZERO: BlockMtpInterval

Block MTP interval 0.

pub const MIN: BlockMtpInterval = Self::ZERO

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

pub const MAX: BlockMtpInterval

The maximum block MTP interval.

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

Constructs a new block MTP interval from a u32.

pub const fn to_u32(self) -> u32

Returns block MTP interval as a u32.

pub const fn to_relative_mtp_interval_floor( self, ) -> Result<NumberOf512Seconds, TimeOverflowError>

Converts a BlockMtpInterval to a [locktime::relative::NumberOf512Seconds], rounding down.

Relative timelock MTP intervals have a resolution of 512 seconds, while BlockMtpInterval, like all block timestamp types, has a one-second resolution.

Errors

Errors if the MTP is out-of-range (in excess of 512 times u16::MAX seconds, or about 388 days) for a time-based relative locktime.

pub const fn to_relative_mtp_interval_ceil( self, ) -> Result<NumberOf512Seconds, TimeOverflowError>

Converts a BlockMtpInterval to a [locktime::relative::NumberOf512Seconds], rounding up.

Relative timelock MTP intervals have a resolution of 512 seconds, while BlockMtpInterval, like all block timestamp types, has a one-second resolution.

Errors

Errors if the MTP is out-of-range (in excess of 512 times u16::MAX seconds, or about 388 days) for a time-based relative locktime.

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

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

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

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

Trait Implementations

impl Add for BlockMtpInterval

type Output = BlockMtpInterval

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add<&'a BlockMtpInterval> for &BlockMtp

type Output = <BlockMtp as Add<BlockMtpInterval>>::Output

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = <BlockMtpInterval as Add>::Output

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&BlockMtpInterval> for BlockMtp

type Output = <BlockMtp as Add<BlockMtpInterval>>::Output

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&BlockMtpInterval> for BlockMtpInterval

type Output = <BlockMtpInterval as Add>::Output

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<BlockMtpInterval> for BlockMtp

type Output = BlockMtp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<BlockMtpInterval> for &BlockMtp

type Output = <BlockMtp as Add<BlockMtpInterval>>::Output

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<BlockMtpInterval> for &BlockMtpInterval

type Output = <BlockMtpInterval as Add>::Output

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for BlockMtpInterval

fn add_assign(&mut self, rhs: BlockMtpInterval)

Performs the += operation.

impl AddAssign<&BlockMtpInterval> for BlockMtpInterval

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

Performs the += operation.

impl<'a> Arbitrary<'a> for BlockMtpInterval

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<BlockMtpInterval, 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 BlockMtpInterval

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

Formats the value using the given formatter.

impl Clone for BlockMtpInterval

fn clone(&self) -> BlockMtpInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BlockMtpInterval

impl Debug for BlockMtpInterval

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

Formats the value using the given formatter.

impl Default for BlockMtpInterval

fn default() -> BlockMtpInterval

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BlockMtpInterval

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockMtpInterval

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

Formats the value using the given formatter.

impl Eq for BlockMtpInterval

impl From<BlockMtpInterval> for u32

fn from(height: BlockMtpInterval) -> u32

Converts to this type from the input type.

impl From<NumberOf512Seconds> for BlockMtpInterval

fn from(h: NumberOf512Seconds) -> BlockMtpInterval

Converts a [locktime::relative::NumberOf512Seconds] to a BlockMtpInterval.

A relative locktime MTP interval has a resolution of 512 seconds, and a maximum value of u16::MAX 512-second intervals. BlockMtpInterval may take the full range of u32.

impl From<u32> for BlockMtpInterval

fn from(inner: u32) -> BlockMtpInterval

Converts to this type from the input type.

impl FromStr for BlockMtpInterval

type Err = ParseIntError

The associated error which can be returned from parsing.

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

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

impl Hash for BlockMtpInterval

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 BlockMtpInterval

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

Formats the value using the given formatter.

impl Octal for BlockMtpInterval

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

Formats the value using the given formatter.

impl Ord for BlockMtpInterval

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BlockMtpInterval

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

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

impl Sub for BlockMtpInterval

type Output = BlockMtpInterval

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<&'a BlockMtpInterval> for &BlockMtp

type Output = <BlockMtp as Sub<BlockMtpInterval>>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = <BlockMtpInterval as Sub>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&BlockMtpInterval> for BlockMtp

type Output = <BlockMtp as Sub<BlockMtpInterval>>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&BlockMtpInterval> for BlockMtpInterval

type Output = <BlockMtpInterval as Sub>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<BlockMtpInterval> for BlockMtp

type Output = BlockMtp

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<BlockMtpInterval> for &BlockMtp

type Output = <BlockMtp as Sub<BlockMtpInterval>>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<BlockMtpInterval> for &BlockMtpInterval

type Output = <BlockMtpInterval as Sub>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for BlockMtpInterval

fn sub_assign(&mut self, rhs: BlockMtpInterval)

Performs the -= operation.

impl SubAssign<&BlockMtpInterval> for BlockMtpInterval

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

Performs the -= operation.

impl Sum for BlockMtpInterval

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

where I: Iterator<Item = BlockMtpInterval>,

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

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

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

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

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

impl TryFrom<&str> for BlockMtpInterval

type Error = ParseIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Box<str>> for BlockMtpInterval

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<BlockMtpInterval, <BlockMtpInterval as TryFrom<Box<str>>>::Error>

Performs the conversion.

impl TryFrom<String> for BlockMtpInterval

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<BlockMtpInterval, <BlockMtpInterval as TryFrom<String>>::Error>

Performs the conversion.

impl UpperHex for BlockMtpInterval

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

Formats the value using the given formatter.