Struct networking::BitcoinCodec

pub struct BitcoinCodec { /* fields omitted */ }

A Codec converting a raw TcpStream into a Sink + Stream of Bitcoin Wire Protocol Messages.

This struct handles the serialization and sending of Messages. Callers simply construct a Framed instance containing the codec and the TcpStream.

// Note: This example does not compile outside the context of an async runtime.
let connection = tokio::net::TcpStream::connect("127.0.0.1:8333".into()).await?;
let codec = networking::BitcoinCodec::new(0);
let connection = Framed::new(connection, codec);

// Create and send a message.
let msg = Message::Verack{};
connection.send(msg).await?;
// Await the response.
let response: Message  = connection.next().await?;

Implementations

impl Codec

pub fn new(magic: u32) -> Codec

Trait Implementations

impl Debug for Codec

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

Formats the value using the given formatter.

impl Decoder for Codec

type Error = DeserializationError

The type of unrecoverable frame decoding errors.

type Item = Message

The type of decoded frames.

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, 

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 = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.