Struct Frame 

pub struct Frame { /* private fields */ }

An immutable view into a SOFH-enclosed message, complete with encoding type and payload.

This type is returned in a borrowed form from [sofh::Codec::decode].

Implementations

impl Frame

pub fn encoding_type(&self) -> u16

Returns the 16-bits encoding type of this Frame. You may want to convert this value to an EncodingType, which facilites validation via pattern matching.

pub fn payload(&self) -> &[u8]

Returns an immutable reference to the actual contents of self, i.e. without its header.

Trait Implementations

impl Debug for Frame

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

Formats the value using the given formatter.

impl Decoder<Frame> for Codec

type Error = DecodeError

The type returned in the event of a deserialization error.

fn decode(&mut self, data: &[u8]) -> Result<&Frame, Self::Error>

Parses the contents of data into a message M, which is then returned in the form of an immutable reference. In the event of failure, this method will return Self::Error.

impl<'a> Encoder<Frame> for Codec

type Error = EncodeError

The type returned in the event of a serialization error.

fn encode( &mut self, buffer: impl Buffer, message: &Frame, ) -> Result<usize, Self::Error>

Encodes message to buffer. It then returns the number of bytes written to buffer.

fn encode_to_vec(&mut self, message: &M) -> Result<Vec<u8>, Self::Error>

Allocates a buffer on the heap and encodes message to it.

impl StreamingDecoder<Frame> for BufCodec

type Error = DecodeError

The type returned in the event of a deserialization error.

fn supply_buffer(&mut self) -> &mut [u8]

Returns a mutable slice of bytes to accomodate for new input.

fn attempt_decoding(&mut self) -> Result<Option<&Frame>, Self::Error>

Validates the contents of the internal buffer and possibly caches the resulting message. When successful, this method will return a Poll to let the caller know whether more bytes are needed or not.

fn get(&self) -> &Frame

fn frames_streamiter<R>(self, reader: R) -> Frames<Self, R, M, Self::Error>

where R: Read,