Enum FramingError 

pub enum FramingError {
    FrameTooLarge {
        limit: MaxFrameSize,
        at_least: usize,
    },
    NotUtf8 {
        valid_up_to: usize,
    },
}

A frame that could not be framed.

A domain error: the framing layer knows about sizes and encodings and nothing else, so nothing in it is an io::Error or a serde_json::Error, and an adapter that hits a broken pipe maps that at its own boundary instead.

Every field is Copy, so the whole error is: it is a size and an offset, and there is nothing in it worth owning twice.

Variants

FrameTooLarge

A frame exceeded the decoder’s configured limit.

Raised while the bytes are still being read, so the decoder is holding at most at_least bytes of the offending frame and the peer cannot make that number grow by declining to send a terminator.

Fields

limit: MaxFrameSize

The limit the caller configured.

at_least: usize

How many bytes of this frame had arrived when the refusal happened.

A lower bound, not a length. The frame has no known length — that is the situation — so this is what was buffered, one byte past the limit.

NotUtf8

A frame’s bytes were not valid UTF-8.

Refused rather than replaced. A lossy decode would hand the next layer a message the peer did not send, and JSON-RPC ids are compared as text, so the corruption would surface as a routing bug rather than as an encoding one.

Fields

valid_up_to: usize

Offset within the frame at which decoding stopped being possible.

Trait Implementations

impl Clone for FramingError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FramingError

impl Debug for FramingError

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

Formats the value using the given formatter.

impl Display for FramingError

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

Formats the value using the given formatter.

impl Eq for FramingError

impl Error for FramingError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<FramingError> for SourceError

fn from(source: FramingError) -> Self

Converts to this type from the input type.

impl PartialEq for FramingError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FramingError