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 order/equality

Usage of the ordering and equality traits for this type may be surprising. Converting between CompactTarget and Target is lossy in both directions (there are multiple CompactTarget values that map to the same Target value). Ordering and equality for this type are defined in terms of the underlying u32.

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

Returns the consensus encoded u32 representation of this CompactTarget.

pub fn to_hex(self) -> String

👎Deprecated since 1.0.0-rc.0:

use format!("{var:x}") instead

Gets the hex representation of this CompactTarget.

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) -> CompactTarget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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 From<CompactTarget> for Target

fn from(c: CompactTarget) -> Self

Converts to this type from the input type.

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

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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<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.

impl Copy for CompactTarget

impl Eq for CompactTarget

impl StructuralPartialEq for CompactTarget