Enum ProtocolError 

#[non_exhaustive]
pub enum ProtocolError {
    InvalidMultibulkLength,
    InvalidBulkLength,
    ExpectedDollar(u8),
    TooBigMbulkCount,
    TooBigBulkCount,
    TooBigInline,
    UnbalancedQuotes,
    UnknownType(u8),
    TooDeep,
    Unsupported(u8),
}

A frame the codec will not accept.

This is a value rather than a string because the connection has to do two things with it: write the Redis text to the client, and close the connection, which is what Redis does after any protocol error.

Variants (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.

InvalidMultibulkLength

The * count was not an integer, was negative past what Redis allows, or was larger than the multibulk limit.

InvalidBulkLength

The $ length was not an integer, was negative, or was larger than the bulk limit.

ExpectedDollar(u8)

An argument did not begin with $. Carries the byte that was there instead, because that byte is in the message Redis sends.

TooBigMbulkCount

The * count line has not ended and there is already more pending than an inline request is allowed to be.

TooBigBulkCount

The $ length line has not ended and there is already more pending than an inline request is allowed to be.

TooBigInline

An inline request has no newline and has passed the inline limit.

UnbalancedQuotes

An inline request opened a quote it never closed.

UnknownType(u8)

A reply began with a byte that is not a type in either protocol. Carries the byte.

TooDeep

A reply nested deeper than the configured limit. This is only reachable from the reply decoder, which is the one part of the codec that recurses.

Unsupported(u8)

A frame this build does not decode, currently the streamed aggregates and streamed strings. Carries the type byte.

Implementations

impl ProtocolError

pub fn write_reply(&self, out: &mut Vec<u8>)

Appends the error line the client should see, - and CRLF included.

Written straight into the output buffer rather than returned as a String, because the failure path runs on a shard thread too and a shard thread that allocates aborts.

Trait Implementations

impl Clone for ProtocolError

fn clone(&self) -> ProtocolError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProtocolError

impl Debug for ProtocolError

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

Formats the value using the given formatter.

impl Display for ProtocolError

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

Formats the value using the given formatter.

impl Eq for ProtocolError

impl Error for ProtocolError

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<ProtocolError> for Error

fn from(e: ProtocolError) -> Error

A protocol error reaching the typed API is an invalid argument, because on that side of the boundary the caller handed us the bytes.

impl PartialEq for ProtocolError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProtocolError