Struct BlockMtp 

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

The median timestamp of 11 consecutive blocks.

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

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

Implementations

impl BlockMtp

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

Constructs a new BlockMtp from an unprefixed hex string.

Errors

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

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

Constructs a new BlockMtp from a prefixed hex string.

Errors

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

impl BlockMtp

pub const ZERO: BlockMtp

Block MTP 0.

Since MTP is a timestamp, 0 is before Bitcoin was invented. This const may still be useful for some use cases e.g., folding a sum of intervals.

pub const MIN: BlockMtp = Self::ZERO

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

pub const MAX: BlockMtp

The maximum block MTP.

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

Constructs a new block MTP from a u32.

pub const fn to_u32(self) -> u32

Returns block MTP as a u32.

pub fn new(timestamps: [BlockTime; 11]) -> BlockMtp

Constructs a BlockMtp by computing the median‐time‐past from the last 11 block timestamps

Because block timestamps are not monotonic, this function internally sorts them; it is therefore not important what order they appear in the array; use whatever is most convenient.

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

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

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

Attempt to add an interval to this BlockMtp, returning None if overflow occurred.

Trait Implementations

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 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 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<'a> Arbitrary<'a> for BlockMtp

Available on crate feature arbitrary only.

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

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

Formats the value using the given formatter.

impl Clone for BlockMtp

fn clone(&self) -> BlockMtp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BlockMtp

impl Debug for BlockMtp

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockMtp

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockMtp

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

Formats the value using the given formatter.

impl Eq for BlockMtp

impl From<BlockMtp> for u32

fn from(height: BlockMtp) -> u32

Converts to this type from the input type.

impl From<MedianTimePast> for BlockMtp

fn from(h: MedianTimePast) -> BlockMtp

Converts a [locktime::absolute::MedianTimePast] to a BlockMtp.

An absolute locktime MTP has a minimum value of absolute::LOCK_TIME_THRESHOLD, while BlockMtp may take the full range of u32.

impl From<u32> for BlockMtp

fn from(inner: u32) -> BlockMtp

Converts to this type from the input type.

impl FromStr for BlockMtp

type Err = ParseIntError

The associated error which can be returned from parsing.

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

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

impl Hash for BlockMtp

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 BlockMtp

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

Formats the value using the given formatter.

impl Octal for BlockMtp

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

Formats the value using the given formatter.

impl Ord for BlockMtp

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BlockMtp

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

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 BlockMtp

impl Sub for BlockMtp

type Output = BlockMtpInterval

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = <BlockMtp as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: &BlockMtp) -> <&BlockMtp as Sub<&'a BlockMtp>>::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 Sub<&BlockMtp> for BlockMtp

type Output = <BlockMtp as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: &BlockMtp) -> <BlockMtp as Sub<&BlockMtp>>::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<BlockMtp> for &BlockMtp

type Output = <BlockMtp as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: BlockMtp) -> <&BlockMtp as Sub<BlockMtp>>::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 TryFrom<&str> for BlockMtp

type Error = ParseIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<BlockMtp> for MedianTimePast

fn try_from( h: BlockMtp, ) -> Result<MedianTimePast, <MedianTimePast as TryFrom<BlockMtp>>::Error>

Converts a BlockMtp to a [locktime::absolute::MedianTimePast].

An absolute locktime MTP has a minimum value of absolute::LOCK_TIME_THRESHOLD, while BlockMtp may take the full range of u32.

type Error = ConversionError

The type returned in the event of a conversion error.

impl TryFrom<Box<str>> for BlockMtp

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

Performs the conversion.

impl TryFrom<String> for BlockMtp

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

Performs the conversion.

impl UpperHex for BlockMtp

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

Formats the value using the given formatter.