Enum ClientError 

pub enum ClientError {
    DriverStopped,
    CommandQueueFull,
    PushBufferFull(String),
    DuplicateChannel(String),
    AlreadyJoined(String),
    ChannelNotJoined(String),
    SocketNotConnected,
    BinaryNotSupported,
    Timeout {
        operation: ClientOperation,
        timeout: Duration,
    },
    Interrupted {
        operation: ClientOperation,
    },
    Protocol(String),
    JoinPayload {
        topic: String,
        message: String,
    },
    JoinRejected {
        topic: String,
        response: Payload,
    },
    UnknownTopic(String),
}

Failure returned by the managed socket or channel API.

Variants

DriverStopped

The driver stopped and cannot accept more commands.

CommandQueueFull

A non-blocking subscription command could not enter the bounded queue.

PushBufferFull(String)

Too many calls are waiting for this topic to become joined.

DuplicateChannel(String)

A channel handle already exists for this topic.

AlreadyJoined(String)

The requested channel is already joined or joining.

ChannelNotJoined(String)

The channel must be joined before accepting this operation.

SocketNotConnected

The operation requires an active socket connection.

BinaryNotSupported

The active transport cannot carry Phoenix binary frames.

Timeout

The requested operation did not complete before its deadline.

Fields

operation: ClientOperation

Operation that timed out.

timeout: Duration

Applied timeout duration.

Interrupted

A transmitted operation lost its connection before receiving a reply.

Fields

operation: ClientOperation

Interrupted operation.

Protocol(String)

Protocol state rejected an operation or incoming frame.

JoinPayload

Loading a fresh join payload failed.

Fields

topic: String

Topic whose payload could not be loaded.

message: String

Loader-provided error message.

JoinRejected

Phoenix returned an error reply to a join.

Fields

topic: String

Rejected topic.

response: Payload

Server rejection payload.

UnknownTopic(String)

No registered channel matched the topic.

Trait Implementations

impl Clone for ClientError

fn clone(&self) -> ClientError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientError

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

Formats the value using the given formatter.

impl Display for ClientError

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

Formats the value using the given formatter.

impl Error for ClientError

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<ClientError> for CallJsonError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl PartialEq for ClientError

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