Struct jsonrpc_server_utils::codecs::StreamCodec

pub struct StreamCodec { /* fields omitted */ }

Stream codec for streaming protocols (ipc, tcp)

Methods

impl StreamCodec

pub fn stream_incoming() -> Self

Default codec with streaming input data. Input can be both enveloped and not.

pub fn new(incoming_separator: Separator, outgoing_separator: Separator) -> Self

New custom stream codec

Trait Implementations

impl Default for StreamCodec

fn default() -> StreamCodec

Returns the "default value" for a type.

impl Debug for StreamCodec

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

Formats the value using the given formatter.

impl Encoder for StreamCodec

type Item = String

The type of items consumed by the Encoder

type Error = Error

The type of encoding errors.

fn encode(&mut self, msg: String, buf: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.

impl Decoder for StreamCodec

type Item = String

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

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
    Self: Encoder,
    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.