Struct CompactSizeU64Decoder 

pub struct CompactSizeU64Decoder { /* private fields */ }

Decodes a compact size encoded integer as a raw u64.

If you are decoding a length prefix, you probably want CompactSizeDecoder instead.

This decoder performs no limit check and no conversion to usize. It exists for the small number of Bitcoin protocol fields that are compact-size-encoded integers but are not length prefixes (e.g. service flags in the version message). For those fields the full u64 range is meaningful and there is no associated allocation whose size would be controlled by the decoded value.

Denial-of-service warning

Do not use this decoder for length prefixes. If the decoded value is used to size an allocation, for example as the length of a Vec, a malicious peer can send a compact size value of up to 2^64-1 and cause an out-of-memory condition. CompactSizeDecoder prevents this by enforcing a configurable upper bound before returning the value.

For more information about decoders see the documentation of the Decoder trait.

Implementations

impl CompactSizeU64Decoder

pub const fn new() -> Self

Constructs a new CompactSizeU64Decoder.

See the struct-level documentation for guidance on when to use this decoder versus CompactSizeDecoder.

Trait Implementations

impl Clone for CompactSizeU64Decoder

fn clone(&self) -> CompactSizeU64Decoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompactSizeU64Decoder

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

Formats the value using the given formatter.

impl Decoder for CompactSizeU64Decoder

type Output = u64

The type that this decoder produces when decoding is complete.

type Error = CompactSizeDecoderError

The error type that this decoder can produce.

fn push_bytes(&mut self, bytes: &mut &[u8]) -> Result<bool, Self::Error>

Pushes bytes into the decoder, consuming as much as possible.

fn end(self) -> Result<Self::Output, Self::Error>

Completes the decoding process and return the final result.

fn read_limit(&self) -> usize

Returns the maximum number of bytes this decoder can consume without over-reading.

impl Default for CompactSizeU64Decoder

fn default() -> Self

Returns the “default value” for a type.