Enum RithmicError 

#[non_exhaustive]
pub enum RithmicError {
    ConnectionFailed(String),
    ConnectionClosed,
    SendFailed,
    EmptyResponse,
    RequestRejected(RithmicRequestError),
    ProtocolError(String),
    InvalidArgument(String),
    HeartbeatTimeout,
    ForcedLogout(String),
}

Typed errors returned by all plant handle methods.

match handle.subscribe("ESH6", "CME").await {
    Ok(resp) => { /* success */ }
    Err(RithmicError::ConnectionClosed | RithmicError::SendFailed) => {
        handle.abort();
        // reconnect — see examples/reconnect.rs
    }
    Err(RithmicError::InvalidArgument(msg)) => eprintln!("bad input: {msg}"),
    Err(RithmicError::RequestRejected(err)) => {
        eprintln!(
            "rejected code={} msg={}",
            err.code.as_deref().unwrap_or("?"),
            err.message.as_deref().unwrap_or(""),
        );
    }
    Err(e) => eprintln!("{e}"),
}

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.

ConnectionFailed(String)

WebSocket connection could not be established.

ConnectionClosed

The plant’s WebSocket connection is gone; pending requests will never complete.

SendFailed

WebSocket send failed or timed out after the request was registered.

Treat as a connection-health failure. This error alone does not prove the actor has shut down; keep-alive failure detection can still emit crate::rti::messages::RithmicMessage::HeartbeatTimeout or crate::rti::messages::RithmicMessage::ConnectionError if the connection is actually dead.

EmptyResponse

Server returned an empty response where at least one was expected.

RequestRejected(RithmicRequestError)

Structured protocol-level rejection preserving the Rithmic rp_code tuple. Not a reconnect signal — request-level only.

ProtocolError(String)

Non-transport, non-rp_code response failure (e.g. decode failures or other protocol-level outcomes that don’t carry rp_code). Not a reconnect signal.

InvalidArgument(String)

A caller-supplied argument is invalid (the message describes which argument and why).

HeartbeatTimeout

Keep-alive detected the connection is dead.

ForcedLogout(String)

Server terminated the session with a reason string.

Implementations

impl RithmicError

pub fn is_connection_issue(&self) -> bool

Returns true when this error reflects a transport/connection-health failure rather than a protocol-level rejection.

pub fn as_connection_message(&self) -> RithmicMessage

Maps this error to the synthetic subscription RithmicMessage that a connection-health broadcast should carry. HeartbeatTimeout preserves the keep-alive signal; every other variant surfaces as ConnectionError.

Trait Implementations

impl Clone for RithmicError

fn clone(&self) -> RithmicError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RithmicError

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

Formats the value using the given formatter.

impl Display for RithmicError

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

Formats the value using the given formatter.

impl Eq for RithmicError

impl Error for RithmicError

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 RithmicError

fn eq(&self, other: &RithmicError) -> 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 StructuralPartialEq for RithmicError