Struct Frame

pub struct Frame {
    pub size: u64,
    pub crc32c: u32,
}

Messages on the wire are preceded by frames. Frames are framed by a solitary varint.

Fields

size: u64

The size of the message this frame represents.

crc32c: u32

The crc32c of this frame.

Implementations

impl Frame

pub fn from_buffer(buf: &[u8]) -> Self

Given a buffer, create the frame that should precede it on the wire.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Frame

Returns the “default value” for a type.

impl<'prototk> FieldPackHelper<'prototk, message<Frame>> for Frame

fn field_pack_sz(&self, tag: &Tag) -> usize

The size of encoding self with tag.

fn field_pack(&self, tag: &Tag, out: &mut [u8])

Pack the tag into the output buffer.

impl<'prototk> FieldUnpackHelper<'prototk, message<Frame>> for Frame

fn merge_field(&mut self, proto: message<Frame>)

Merge the proto into self.

impl From<message<Frame>> for Frame

fn from(proto: message<Self>) -> Self

Converts to this type from the input type.

impl Packable for Frame

fn pack_sz(&self) -> usize

pack_sz returns the number of bytes required to serialize the Packable object.

fn pack(&self, buf: &mut [u8])

pack fills in the buffer out with the packed binary representation of the Packable object. The implementor is responsible to ensure that out is exactly pack_sz() bytes and implementations are encouraged to assert this.

fn stream<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

stream writes the object to the provided writer using the same representation that would be used in a call to pack. The implementor is responsible for making sure that the number of bytes written is exactly equal to the number of required bytes.

impl<'prototk> Unpackable<'prototk> for Frame

type Error = Error

Type of error this unpackable returns.

fn unpack<'b>(buf: &'b [u8]) -> Result<(Self, &'b [u8]), Error>

where 'b: 'prototk,

unpack attempts to return an Unpackable object stored in a prefix of buf. The method returns the result and remaining unused buffer.

impl<'prototk> Message<'prototk> for Frame