Struct binate::frame::codec::ErrorFrame

pub struct ErrorFrame { /* fields omitted */ }

This is supported on crate feature frame only.

The error frame.

Error frames are used for errors on individual requests/streams as well as connection errors and in response to SETUP frames.

Frame Contents

0                   1                   2                   3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                           Stream ID                           |
+-----------+-+-+---------------+-------------------------------+
|Frame Type |0|0|      Flags    |
+-----------+-+-+---------------+-------------------------------+
|                          Error Code                           |
+---------------------------------------------------------------+
                           Error Data

A Stream ID of 0 means the error pertains to the connection., including connection establishment. A Stream ID > 0 means the error pertains to a given stream.

The Error Data is typically an Exception message, but could include stringified stacktrace information if appropriate.

See the Frame Error section of the RSocket protocol spec for more information.

Implementations

impl ErrorFrame

pub const INVALID_SETUP: u32

The Setup frame is invalid for the server (it could be that the client is too recent for the old server).

Stream ID MUST be 0.

pub const UNSUPPORTED_SETUP: u32

Some (or all) of the parameters specified by the client are unsupported by the server.

Stream ID MUST be 0.

pub const REJECTED_SETUP: u32

The server rejected the setup, it can specify the reason in the payload.

Stream ID MUST be 0.

pub const REJECTED_RESUME: u32

The server rejected the resume, it can specify the reason in the payload.

Stream ID MUST be 0.

pub const CONNECTION_ERROR: u32

The connection is being terminated.

Sender or Receiver of this frame MAY close the connection immediately without waiting for outstanding streams to terminate. Stream ID MUST be 0.

pub const CONNECTION_CLOSE: u32

The connection is being terminated.

Sender or Receiver of this frame MUST wait for outstanding streams to terminate before closing the connection. New requests MAY not be accepted. Stream ID MUST be 0.

pub const APPLICATION_ERROR: u32

Application layer logic generating a Reactive Streams onError event.

Stream ID MUST be > 0.

pub const REJECTED: u32

Despite being a valid request, the Responder decided to reject it.

The Responder guarantees that it didn’t process the request. The reason for the rejection is explained in the Error Data section. Stream ID MUST be > 0.

pub const CANCELED: u32

The Responder canceled the request but may have started processing it (similar to REJECTED but doesn’t guarantee lack of side-effects).

Stream ID MUST be > 0.

pub const INVALID: u32

The request is invalid. Stream ID MUST be > 0.

pub const MIN_APPLICATION_ERROR_CODE: u32

The minimum error code that can used as application layer error.

pub const MAX_APPLICATION_ERROR_CODE: u32

The maximum error code that can used as application layer error.

pub const TYPE: FrameType

Type of this frame.

impl ErrorFrame

pub fn new(stream_id: u32, error_code: u32, data: Option<Bytes>) -> Self

Create a new ErrorFrame.

• stream_id and error_code MUST be <= MAX_U31.
• data SHOULD be a UTF-8 encoded string.

pub fn stream_id(&self) -> u32

Returns the stream ID of this frame.

pub fn error_code(&self) -> u32

Returns the error code in this error frame.

pub fn data(&self) -> Option<&Bytes>

Returns the error data attached to this frame, if any.

pub fn data_utf8(&self) -> Option<&str>

Returns the error data in this error frame in UTF-8 format. If the error data is not valid UTF-8, this will return None.

Trait Implementations

impl Clone for ErrorFrame

fn clone(&self) -> ErrorFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorFrame

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

Formats the value using the given formatter.

impl Decode for ErrorFrame

type Value = Self

The value decoded into.

fn decode<B: Buf>(
    buf: &mut B,
    stream_id: u32,
    _flags: Flags
) -> Result<Self::Value, DecodeError>

Decodes the given bytes into a frame.

impl Encode for ErrorFrame

fn encode(&self, buf: &mut BytesMut)

Encodes self into bytes.

fn len(&self) -> usize

Returns the length (in bytes) of this value.

fn is_empty(&self) -> bool

Returns whether this value is empty.

fn to_bytes(&self) -> Bytes

Encodes self into bytes.

impl PartialEq<ErrorFrame> for ErrorFrame

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

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

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

This method tests for !=.

impl Eq for ErrorFrame

impl StructuralEq for ErrorFrame

impl StructuralPartialEq for ErrorFrame