Enum lawn_protocol::protocol::ResponseCode

pub enum ResponseCode {
    Success,
    Continuation,
    NeedsAuthentication,
    Forbidden,
    Closing,
    Errno,
    AuthenticationFailed,
    Gone,
    NotFound,
    InternalError,
    ChannelDead,
    NotEnabled,
    NotSupported,
    ParametersNotSupported,
    Invalid,
    TooLarge,
    TooManyMessages,
    InvalidParameters,
}

Overview

The protocol is relatively simple. Each request consists of a 32-bit size of the resulting message, a 32-bit request ID, a 32-bit message type, and an optional per-message CBOR blob representing message data. For performance and security reasons, the message size is limited to 2^24 in size. The size includes all fields other than the size.

Each response consists of a 32-bit size of the message, the 32-bit request ID, a 32-bit response code, and an optional per-response code CBOR blob.

The bottom 31 bits of the request ID may be any value; the response will use the same ID. No check is made for duplicates, so the requestor should prefer not repeating IDs that are in flight. The top bit is clear if the request is client-to-server request and it is set if the request is a server-to-client request. This helps eliminate confusion as to whether a message is a request or a response.

All data is serialized in a little-endian format. The response codes for the protocol.

The response codes are based around IMAP’s response codes, and the top two bytes of the response indicates the type:

• 0: success
• 1: no (roughly, the request was understood, but not completed)
• 2: bad (roughly, the request was not understood)

Variants

Success

The request was successful. The response contains the requested data.

Continuation

The request is incomplete, but is so far successful. The request should continue, referencing the ID of the last request.

NeedsAuthentication

The request requires authentication.

The semantics for this message are equivalent to an HTTP 401 response.

Forbidden

The message was not allowed.

The semantics for this message are equivalent to an HTTP 403 response.

Closing

The server is shutting down.

Errno

The message failed for a system error reason.

This is generally only useful for certain types of channels.

AuthenticationFailed

Gone

The other end of the channel has disappeared.

NotFound

InternalError

ChannelDead

The channel has ceased to produce new data and this operation cannot complete.

NotEnabled

The message type was not enabled.

NotSupported

The message type was not supported.

ParametersNotSupported

The parameters were not supported.

Invalid

The message type was received, but was not valid.

TooLarge

The message was too large.

TooManyMessages

There are too many pending messages.

InvalidParameters

The parameters are supported, but not correct.

For example, if a selector is not valid for a channel, this message may be sent.

Trait Implementations

impl Clone for ResponseCode

fn clone(&self) -> ResponseCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseCode

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

Formats the value using the given formatter.

impl From<ResponseCode> for Error

fn from(code: ResponseCode) -> Error

Converts to this type from the input type.

impl FromPrimitive for ResponseCode

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Ord for ResponseCode

fn cmp(&self, other: &ResponseCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ResponseCode> for ResponseCode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ResponseCode> for ResponseCode

fn partial_cmp(&self, other: &ResponseCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ResponseCode

impl Eq for ResponseCode

impl StructuralEq for ResponseCode

impl StructuralPartialEq for ResponseCode