Struct essrpc::transports::BincodeTransport

pub struct BincodeTransport<C: Read + Write> { /* fields omitted */ }

Transport implementation using Bincode serialization. Can be used over any Read+Write channel (local socket, internet socket, pipe, etc). The present implementation is naive with regards to this channel – no buffering is performed. Enable the “bincode_transport” feature to use this.

Implementations

impl<C: Read + Write> BincodeTransport<C>

pub fn new(channel: C) -> Self

pub fn channel(&self) -> &C

Get the underlying read/write channel

Trait Implementations

impl<C: Read + Write> ClientTransport for BincodeTransport<C>

type TXState = Vec<u8>

Type of transport-internal state used when bulding a call for transmission on the client. May be unit if the transport does not need to track state or does so through member variables.

type FinalState = ()

Type of state object returned from tx_finalize and consumed by rx_response. May be unit.

fn tx_begin_call(&mut self, method: MethodId) -> Result<Vec<u8>, RPCError>

Begin calling the given method. The transport may begin transmitting over the wire, or it may may wait until the call to tx_finalize.

fn tx_add_param(
    &mut self,
    _name: &'static str,
    value: impl Serialize,
    state: &mut Vec<u8>
) -> Result<(), RPCError>

Add a parameter to a method call started with tx_begin_call. This method is guaranteed to be called only after tx_begin_call and to be called appropriately for each parameter of the method passed to tx_begin_call. state is the object returned by tx_begin_call. Parameters are always added and read in order, so transmitting the name is not a requirement.

fn tx_finalize(&mut self, state: Vec<u8>) -> Result<(), RPCError>

Finalize transmission of a method call. Called only after tx_begin_call and appropriate calls to tx_add_param. If the transport has not yet transmitted the method identifier and parameters over the wire, it should do so at this time.

fn rx_response<T>(&mut self, _state: ()) -> Result<T, RPCError> where
    for<'de> T: Deserialize<'de>, 

Read the return value of a method call. Always called after tx_finalize. state is the object returned by tx_finalize.

impl<C: Read + Write> ServerTransport for BincodeTransport<C>

type RXState = VecReader

Type of transport-internal state used when receiving a call on the server. May be unit if the transport does not need to track state or does so through member variables.

fn rx_begin_call(
    &mut self
) -> Result<(PartialMethodId, Self::RXState), RPCError>

Begin reading a method cal on the server. Returns the method name or identifier and internal state.

fn rx_read_param<T>(
    &mut self,
    _name: &'static str,
    state: &mut Self::RXState
) -> Result<T, RPCError> where
    for<'de> T: Deserialize<'de>, 

Read a method parameter after a an rx_begin_call. Parameters are always read in order, so some transports may choose to ignore the name.

fn tx_response(&mut self, value: impl Serialize) -> Result<(), RPCError>

Transmit a response (from the server side) to a method call.