Enum ProtocolError 

#[non_exhaustive]
pub enum ProtocolError {
    Io(Error),
    Codec(FrameError),
    Timeout(&'static str),
    UnexpectedAck {
        version: u8,
        frame_type: u8,
        acked_seq: u32,
        expected_seq: u32,
    },
    PartialAck {
        acked: u32,
        sent: u32,
    },
    NoHostsConfigured,
    AllHostsFailed(Box<Self>),
    WindowTooLarge {
        kind: &'static str,
        requested: usize,
        limit: usize,
    },
    Tls(String),
}

Errors emitted by the high-level client.

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.

Io(Error)

I/O error while reading from or writing to the network.

Codec(FrameError)

Codec error (frame parse / encode failure).

Timeout(&'static str)

Operation timed out (connect, write, or ACK read).

UnexpectedAck

The receiver’s ACK had an unexpected version or frame type, or its sequence number didn’t match what the client just sent.

Fields

version: u8

Wire-byte 0.

frame_type: u8

Wire-byte 1.

acked_seq: u32

Sequence number on the ACK frame.

expected_seq: u32

Sequence number this client expected the ACK to reference.

PartialAck

The receiver acknowledged fewer events than were sent (partial ACK). Surfaces so the caller can decide whether to retry the unacked tail.

Fields

acked: u32

Number of events the receiver acknowledged.

sent: u32

Number of events the client sent in this window.

NoHostsConfigured

No hosts were configured for the client.

AllHostsFailed(Box<Self>)

All configured hosts have been tried and all failed; the wrapped error is the most recent failure.

WindowTooLarge

A peer declared, or streamed, a window that exceeds the server’s configured aggregate limits — either the declared event count or the accumulated event count / byte total grew past the cap.

Surfaces the per-window resource-exhaustion (memory-growth) defence, complementing the per-frame FrameError::PayloadTooLarge / FrameError::DecompressedTooLarge caps. The server stops reading and returns this error rather than accumulating further.

Fields

kind: &'static str

Which aggregate dimension overflowed ("event count" or "byte total").

requested: usize

The value that breached the cap (declared count, observed event count, or accumulated byte total).

limit: usize

The configured cap that was exceeded.

Tls(String)

Available on crate feature tls only.

TLS configuration error (key/cert load, server-name parse, …).

Trait Implementations

impl Debug for ProtocolError

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

Formats the value using the given formatter.

impl Display for ProtocolError

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

Formats the value using the given formatter.

impl Error for ProtocolError

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 ProtocolError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FrameError> for ProtocolError

fn from(source: FrameError) -> Self

Converts to this type from the input type.