Enum Framed 

pub enum Framed<T> {
    Msg(T),
    Undecodable {
        reason: String,
        len: usize,
    },
}

Outcome of reading one frame off the wire.

The distinction this type draws is the load-bearing one: a payload we could not understand is not the same event as a stream we could not read. The first leaves the connection perfectly usable and deserves an answer; the second does not. Collapsing them into one io::Error is what made an unknown request variant hang up the socket.

Variants

Msg(T)

A complete frame that decoded into T.

Undecodable

A complete frame — length prefix honoured, every one of its bytes consumed — whose payload did not decode into T. The canonical cause is a variant from a newer peer’s vocabulary.

The stream is still aligned at the next frame boundary, so the reader may reply and keep reading. Verified by an_undecodable_frame_leaves_the_stream_aligned.

Fields

reason: String

serde’s own message, e.g. unknown variant `Hello` .

len: usize

Payload length that was consumed.

Trait Implementations

impl<T: Debug> Debug for Framed<T>

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

Formats the value using the given formatter.