Skip to main content

FrameError

Enum FrameError 

Source
#[non_exhaustive]
pub enum FrameError { HeaderTooLarge { limit: usize, }, TooManyHeaders { limit: usize, }, InvalidHeader, MissingContentLength, DuplicateContentLength, InvalidContentLength, TooLarge { length: Option<u64>, limit: usize, }, Truncated, }
Expand description

Why a byte stream could not be cut into messages.

Only TooLarge is recoverable: the decoder has skipped (or is skipping) the oversized message without buffering it, and the next message can be read. Every other error leaves the stream with no reliable message boundary, so the decoder stops and returns the same error from then on.

§Examples

use rpc_io::{FrameError, Framing, Limits};

let mut decoder = Framing::ContentLength.decoder(&Limits::new());
decoder.feed(b"Content-Length: 1x\r\n\r\n");
assert_eq!(decoder.next_frame(), Err(FrameError::InvalidContentLength));
assert!(!FrameError::InvalidContentLength.is_recoverable());

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

HeaderTooLarge

A header section exceeded Limits::max_header_bytes.

Fields

§limit: usize

The limit, in bytes.

§

TooManyHeaders

A header section had more than Limits::max_headers lines.

Fields

§limit: usize

The limit, in lines.

§

InvalidHeader

A header line has no :, or its name is not an RFC 9110 token (empty, or holding a space, a brace, or another separator).

§

MissingContentLength

A header section ended without a Content-Length header.

§

DuplicateContentLength

A header section has more than one Content-Length header.

§

InvalidContentLength

A Content-Length value is not a decimal integer that fits in 64 bits.

§

TooLarge

A message exceeded Limits::max_message_bytes. Recoverable: the message is skipped without being buffered.

Fields

§length: Option<u64>

The length the header announced; always None for a newline-delimited line, which is refused as soon as it outgrows the limit, before its length is known.

§limit: usize

The limit, in bytes.

§

Truncated

The stream ended inside a message.

Implementations§

Source§

impl FrameError

Source

pub const fn is_recoverable(&self) -> bool

Whether the decoder can go on to the next message.

§Examples
use rpc_io::FrameError;

assert!(FrameError::TooLarge { length: Some(9), limit: 8 }.is_recoverable());
assert!(!FrameError::Truncated.is_recoverable());

Trait Implementations§

Source§

impl Clone for FrameError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FrameError

Source§

impl Debug for FrameError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for FrameError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for FrameError

Source§

impl Error for FrameError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<FrameError> for Error

Available on crate feature std only.
Source§

fn from(e: FrameError) -> Self

Converts to this type from the input type.
Source§

impl Hash for FrameError

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for FrameError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FrameError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.