Enum StreamErrorKind 

#[non_exhaustive]
pub enum StreamErrorKind {
    RateLimited,
    ServerError,
    InvalidRequest,
    Unknown,
}

Classification of a StreamDelta::Error event.

Mirrors ChatOutcome’s error variants so providers that emit errors via streaming preserve the same precision that non-streaming chat() callers see — every supported provider can map its underlying error (HTTP status, validation failure, mid-stream disconnect) directly onto one of these categories at the construction site.

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.

RateLimited

Provider returned HTTP 429 / explicit rate-limit signal.

ServerError

Provider returned HTTP 5xx, the connection dropped mid-stream, or the provider reported a transient runtime failure.

InvalidRequest

Caller-side error: validation failure before dispatch, HTTP 4xx other than 429, or a non-retriable provider rejection.

Unknown

Escape hatch for a streaming error a provider could not classify into one of the categories above.

Producers should prefer a specific variant whenever the underlying signal (HTTP status, validation failure, mid-stream disconnect) allows it; Unknown exists so future error sources and providers can be added without a breaking change. It is treated as non-recoverable by StreamErrorKind::is_recoverable (callers should not blindly retry an unclassified failure).

Implementations

impl StreamErrorKind

pub const fn is_recoverable(self) -> bool

true when the error is potentially transient and the caller may retry. Rate-limit and server errors are recoverable; invalid-request is not.

Trait Implementations

impl Clone for StreamErrorKind

fn clone(&self) -> StreamErrorKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamErrorKind

impl Debug for StreamErrorKind

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

Formats the value using the given formatter.

impl Eq for StreamErrorKind

impl PartialEq for StreamErrorKind

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