Struct Codec

pub struct Codec {
    builder: Builder,
    state: DecodeState,
}

A codec which produces Bitcoin messages from byte streams and vice versa.

Fields

builder: Builder

state: DecodeState

Implementations

impl Codec

pub fn builder() -> Builder

Return a builder for constructing a Codec.

pub fn reconfigure_version(&mut self, version: Version)

Reconfigure the version used by the codec, e.g., after completing a handshake.

impl Codec

fn body_length(&self, msg: &Message) -> usize

Obtain the size of the body of a given message. This will match the number of bytes written to the writer provided to write_body for the same message.

fn write_body<W: Write>(&self, msg: &Message, writer: W) -> Result<(), Error>

Write the body of the message into the given writer. This allows writing the message body prior to writing the header, so that the header can contain a checksum of the message body.

impl Codec

fn read_version<R: Read>(&self, reader: R) -> Result<Message, Error>

Deserializes a version message.

The relay field is optional, as defined in https://developer.bitcoin.org/reference/p2p_networking.html#version

Note: zcashd only requires fields up to address_recv, but everything up to relay is required in Zebra. see https://github.com/zcash/zcash/blob/11d563904933e889a11d9685c3b249f1536cfbe7/src/main.cpp#L6490-L6507

fn read_verack<R: Read>(&self, _reader: R) -> Result<Message, Error>

fn read_ping<R: Read>(&self, reader: R) -> Result<Message, Error>

fn read_pong<R: Read>(&self, reader: R) -> Result<Message, Error>

fn read_reject<R: Read>(&self, reader: R) -> Result<Message, Error>

pub(super) fn read_addr<R: Read>(&self, reader: R) -> Result<Message, Error>

Deserialize an addr (v1) message into a list of MetaAddrs.

pub(super) fn read_addrv2<R: Read>(&self, reader: R) -> Result<Message, Error>

Deserialize an addrv2 message into a list of MetaAddrs.

Currently, Zebra parses received addrv2s, ignoring some address types. Zebra never sends addrv2 messages.

fn read_getaddr<R: Read>(&self, _reader: R) -> Result<Message, Error>

fn read_block<R: Read + Send>(&self, reader: R) -> Result<Message, Error>

fn read_getblocks<R: Read>(&self, reader: R) -> Result<Message, Error>

fn read_headers<R: Read>(&self, reader: R) -> Result<Message, Error>

Deserialize a headers message.

See [Zcash block header] for the enumeration of these fields.

Zcash block header

fn read_getheaders<R: Read>(&self, reader: R) -> Result<Message, Error>

fn read_inv<R: Read>(&self, reader: R) -> Result<Message, Error>

fn read_getdata<R: Read>(&self, reader: R) -> Result<Message, Error>

fn read_notfound<R: Read>(&self, reader: R) -> Result<Message, Error>

fn read_tx<R: Read + Send>(&self, reader: R) -> Result<Message, Error>

fn read_mempool<R: Read>(&self, _reader: R) -> Result<Message, Error>

fn read_filterload<R: Read>( &self, reader: R, body_len: usize, ) -> Result<Message, Error>

fn read_filteradd<R: Read>( &self, reader: R, body_len: usize, ) -> Result<Message, Error>

fn read_filterclear<R: Read>(&self, _reader: R) -> Result<Message, Error>

fn deserialize_transaction_spawning<R: Read + Send>( reader: R, ) -> Result<Transaction, Error>

Given the reader, deserialize the transaction in the rayon thread pool.

fn deserialize_block_spawning<R: Read + Send>(reader: R) -> Result<Block, Error>

Given the reader, deserialize the block in the rayon thread pool.

Trait Implementations

impl Decoder for Codec

type Item = Message

The type of decoded frames.

type Error = SerializationError

The type of unrecoverable frame decoding errors.

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Encoder<Message> for Codec

type Error = SerializationError

The type of encoding errors.

fn encode( &mut self, item: Message, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.