Struct FetchHeader 

pub struct FetchHeader {
    pub subscribe_id: VarInt,
}

Fetch stream header (follows the stream type varint).

Fields

subscribe_id: VarInt

Subscribe ID this fetch responds to.

Implementations

impl FetchHeader

pub fn encode_stream(&self, buf: &mut impl BufMut)

Encode a fetch stream header including its leading stream-type field, so the bytes form the start of a data stream a peer can read.

Self::encode writes the body alone, which is what a caller wants once the stream is already open and what a caller must not use for its first write. The read side has had Self::decode_stream all along, so without this the codec could not round-trip its own fetch stream through its own reader.

pub fn encode(&self, buf: &mut impl BufMut)

Encode the fetch header into the buffer.

pub fn decode(buf: &mut impl Buf) -> Result<Self, CodecError>

Decode a fetch header from the buffer.

pub fn decode_stream(buf: &mut impl Buf) -> Result<Self, CodecError>

Decode a fetch header from the start of a data stream, consuming the leading stream type varint.

Errors with CodecError::UnknownStreamType when the stream type is one the stream table does not assign, which this draft answers with a close, and with CodecError::InvalidField when it is assigned but is not StreamType::Fetch. stream_type_error draws that line.

Trait Implementations

impl Clone for FetchHeader

fn clone(&self) -> FetchHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FetchHeader

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

Formats the value using the given formatter.

impl Eq for FetchHeader

impl PartialEq for FetchHeader

fn eq(&self, other: &FetchHeader) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FetchHeader