Struct PostcardCodec

pub struct PostcardCodec { /* private fields */ }

Implementations

impl PostcardCodec

pub fn new(max_block_size: usize) -> Self

Trait Implementations

impl Clone for PostcardCodec

fn clone(&self) -> PostcardCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Codec for PostcardCodec

Since Postcard does not support async reads or writes out of the box We prefix Request & Response Messages with the length of the data in bytes We expect the substream to be properly closed when response channel is dropped. Since the request protocol used here expects a response, the sender considers this early close as a protocol violation which results in the connection being closed. If the substream was not properly closed when dropped, the sender would instead run into a timeout waiting for the response.

type Protocol = MessageExchangePostcardProtocol

The type of protocol(s) or protocol versions being negotiated.

type Request = RequestMessage

The type of inbound and outbound requests.

type Response = ResponseMessage

The type of inbound and outbound responses.

fn read_request<'life0, 'life1, 'life2, 'async_trait, T>( &'life0 mut self, _: &'life1 Self::Protocol, socket: &'life2 mut T, ) -> Pin<Box<dyn Future<Output = Result<Self::Request>> + Send + 'async_trait>>

where T: AsyncRead + Unpin + Send + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Reads a request from the given I/O stream according to the negotiated protocol.

fn read_response<'life0, 'life1, 'life2, 'async_trait, T>( &'life0 mut self, _: &'life1 Self::Protocol, socket: &'life2 mut T, ) -> Pin<Box<dyn Future<Output = Result<Self::Response>> + Send + 'async_trait>>

where T: AsyncRead + Unpin + Send + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Reads a response from the given I/O stream according to the negotiated protocol.

fn write_request<'life0, 'life1, 'life2, 'async_trait, T>( &'life0 mut self, _protocol: &'life1 Self::Protocol, socket: &'life2 mut T, req: Self::Request, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where T: AsyncWrite + Unpin + Send + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Writes a request to the given I/O stream according to the negotiated protocol.

fn write_response<'life0, 'life1, 'life2, 'async_trait, T>( &'life0 mut self, _protocol: &'life1 Self::Protocol, socket: &'life2 mut T, res: Self::Response, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where T: AsyncWrite + Unpin + Send + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Writes a response to the given I/O stream according to the negotiated protocol.

impl Debug for PostcardCodec

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

Formats the value using the given formatter.

impl GossipsubCodec for PostcardCodec

type RequestMessage = GossipsubBroadcastRequest

type ResponseMessage = GossipsubMessage

fn encode(&self, data: Self::RequestMessage) -> Result<Vec<u8>, Error>

fn decode( &self, encoded_data: &[u8], gossipsub_tag: GossipTopicTag, ) -> Result<Self::ResponseMessage, Error>

impl NetworkCodec for PostcardCodec

fn get_req_res_protocol(&self) -> <Self as Codec>::Protocol

Returns RequestResponse’s Protocol Needed for initialization of RequestResponse Behaviour