Enum BrokerV2Error 

pub enum BrokerV2Error {
    Sid(SidError),
    PipeName(PipePathError),
    Dial {
        socket_path: String,
        source: Error,
    },
    Framing(FramingError),
    Io(Error),
    Decode(DecodeError),
    MissingResult,
    Refused {
        reason: String,
        retry_after_ms: u64,
        details: Box<Refused>,
    },
    Encode(EncodeError),
}

Errors surfaced by connect.

Variants

Sid(SidError)

user_sid_hash failed.

PipeName(PipePathError)

Building the v2 pipe name failed.

Dial

Dialing the v2 broker pipe failed (no listener, permission denied, …).

Fields

socket_path: String

Path the client attempted to dial.

source: Error

Underlying IO error.

Framing(FramingError)

Framing-layer error on read or write (envelope version mismatch, truncated body, oversized frame, …).

Io(Error)

Underlying IO failure during Hello / HelloReply exchange.

Decode(DecodeError)

HelloReply payload failed to decode.

MissingResult

HelloReply was syntactically valid but missing its result oneof.

Refused

Broker explicitly refused the Hello (returned a Refused reply).

retry_after_ms is promoted from details.retry_after_ms to a top-level field so RateLimited callers don’t have to thread the boxed prost payload back out to honor broker-supplied backoff. Matches the shape of v1’s BrokerClientError::Refused. Fixes #518. details is kept so any future scalar / nested field in the prost message stays accessible without another API break.

Fields

reason: String

Human-readable refusal text.

retry_after_ms: u64

Suggested back-off before retrying (0 = no hint). Mirrors the proto wire type (Refused.retry_after_ms is uint64).

details: Box<Refused>

Decoded refused payload for further inspection by callers.

Encode(EncodeError)

Encoding the outbound Hello failed.

Trait Implementations

impl Debug for BrokerV2Error

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

Formats the value using the given formatter.

impl Display for BrokerV2Error

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

Formats the value using the given formatter.

impl Error for BrokerV2Error

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<DecodeError> for BrokerV2Error

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<EncodeError> for BrokerV2Error

fn from(source: EncodeError) -> Self

Converts to this type from the input type.

impl From<Error> for BrokerV2Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FramingError> for BrokerV2Error

fn from(source: FramingError) -> Self

Converts to this type from the input type.

impl From<PipePathError> for BrokerV2Error

fn from(source: PipePathError) -> Self

Converts to this type from the input type.

impl From<SidError> for BrokerV2Error

fn from(source: SidError) -> Self

Converts to this type from the input type.