Enum RealtimeError 

#[non_exhaustive]
pub enum RealtimeError {
    Connect(String),
    Protocol(String),
    Json(Error),
}

Errors produced by the realtime WebSocket module.

Kept local to this module (rather than reusing the crate-wide OpenAIError) so the realtime surface stays self-contained.

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.

Connect(String)

Failed to build the request or establish the WebSocket connection.

Protocol(String)

A WebSocket protocol-level failure while sending or receiving frames.

Json(Error)

Failed to (de)serialize a JSON event.

Trait Implementations

impl Debug for RealtimeError

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

Formats the value using the given formatter.

impl Display for RealtimeError

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

Formats the value using the given formatter.

impl Error for RealtimeError

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

fn from(source: Error) -> Self

Converts to this type from the input type.