Struct ServerError 

pub struct ServerError {
    pub message: String,
    pub body: Option<String>,
    pub receipt_id: Option<String>,
    pub frame: Frame,
}

Represents an ERROR frame received from the STOMP server.

STOMP servers send ERROR frames to indicate protocol violations, authentication failures, or other server-side errors. After sending an ERROR frame, the server typically closes the connection.

Example

use iridium_stomp::ReceivedFrame;

while let Some(received) = conn.next_frame().await {
    match received {
        ReceivedFrame::Frame(frame) => {
            // Normal message processing
        }
        ReceivedFrame::Error(err) => {
            eprintln!("Server error: {}", err.message);
            if let Some(body) = &err.body {
                eprintln!("Details: {}", body);
            }
            break;
        }
    }
}

Fields

message: String

The error message from the message header.

body: Option<String>

The error body, if present. Contains additional error details.

receipt_id: Option<String>

The receipt-id if this error is in response to a specific frame.

frame: Frame

The original ERROR frame for access to additional headers.

Implementations

impl ServerError

pub fn from_frame(frame: Frame) -> Self

Create a ServerError from an ERROR frame.

This is primarily used internally but is public for testing and advanced use cases where you need to construct a ServerError manually.

Trait Implementations

impl Clone for ServerError

fn clone(&self) -> ServerError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerError

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

Formats the value using the given formatter.

impl Display for ServerError

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

Formats the value using the given formatter.

impl Error for ServerError

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 PartialEq for ServerError

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for ServerError

impl StructuralPartialEq for ServerError