Struct northstar_runtime::api::codec::Codec

pub struct Codec { /* private fields */ }

Newline delimited json

Implementations

impl Codec

pub fn new_with_max_length(max_length: usize) -> Codec

Returns a Codec with a maximum line length limit.

If this is set, calls to Codec::decode will return a io::Error when a line exceeds the length limit. Subsequent calls will discard up to limit bytes from that line until a newline character is reached, returning None until the line over the limit has been fully discarded. After that point, calls to decode will function as normal.

Trait Implementations

impl Decoder for Codec

type Item = Message

The type of decoded frames.

type Error = Error

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 Default for Codec

fn default() -> Codec

Returns the “default value” for a type.

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.