Struct CompactTarget 

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

Encoding of 256-bit target as 32-bit float.

This is used to encode a target into the block header. Satoshi made this part of consensus code in the original version of Bitcoin, likely copying an idea from OpenSSL.

OpenSSL’s bignum (BN) type has an encoding, which is even called “compact” as in Bitcoin, which is exactly this format.

Note on equality

Equality is on the consensus encoded u32. Conversion to Target is lossy, so this type is not ordered. To compare two targets convert them first.

Implementations

impl CompactTarget

pub fn from_consensus(bits: u32) -> Self

Constructs a new CompactTarget from a consensus encoded u32.

pub const fn to_consensus(self) -> u32

👎Deprecated since 0.6.0:

use ‘to_consensus_u32()’ instead

Returns the consensus encoded u32 representation of this CompactTarget.

pub const fn to_consensus_u32(self) -> u32

Returns the consensus encoded u32 representation of this CompactTarget.

pub fn to_target(self) -> Result<Target, InvalidCompactTargetError>

Computes the Target value from this compact representation.

ref: https://developer.bitcoin.org/reference/block_chain.html#target-nbits

Errors

• If the compact value is negative or overflows 256 bits.

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

where Self: Sized,

Constructs a new CompactTarget from a prefixed hex string.

Errors

• If the input string does not contain a 0x (or 0X) prefix.
• If the input string is not a valid hex encoding of a u32.

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

where Self: Sized,

Constructs a new CompactTarget from an unprefixed hex string.

Errors

• If the input string contains a 0x (or 0X) prefix.
• If the input string is not a valid hex encoding of a u32.

Trait Implementations

impl<'a> Arbitrary<'a> for CompactTarget

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

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 CompactTarget

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

Formats the value using the given formatter.

impl Clone for CompactTarget

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CompactTarget

impl Debug for CompactTarget

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

Formats the value using the given formatter.

impl Decode for CompactTarget

Available on crate feature encoding only.

type Decoder = CompactTargetDecoder

Associated decoder for the type.

fn decoder() -> Self::Decoder

Constructs a “default decoder” for the type.

impl<'de> Deserialize<'de> for CompactTarget

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CompactTarget

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

Formats the value using the given formatter.

impl Encode for CompactTarget

Available on crate feature encoding only.

type Encoder<'e> = CompactTargetEncoder<'e>

The encoder associated with this type. Conceptually, the encoder is like an iterator which yields byte slices.

fn encoder(&self) -> Self::Encoder<'_>

Constructs a “default encoder” for the type.

impl Eq for CompactTarget

impl FromStr for CompactTarget

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 CompactTarget

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

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

Formats the value using the given formatter.

impl Octal for CompactTarget

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

Formats the value using the given formatter.

impl PartialEq for CompactTarget

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CompactTarget

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CompactTarget

impl TryFrom<&str> for CompactTarget

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<Box<str>> for CompactTarget

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<Self, Self::Error>

Performs the conversion.

impl TryFrom<CompactTarget> for Target

type Error = InvalidCompactTargetError

The type returned in the event of a conversion error.

fn try_from(c: CompactTarget) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for CompactTarget

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<Self, Self::Error>

Performs the conversion.

impl UpperHex for CompactTarget

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

Formats the value using the given formatter.