Enum SseError 

#[non_exhaustive]
pub enum SseError<E> {
    Transport(E),
    InvalidUtf8(Utf8Error),
    #[non_exhaustive]
    EventTooLarge {
        limit: usize,
    },
}

Why an SseStream (or an SseDecoder, with E = Infallible) failed.

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.

Transport(E)

Reading the body failed: the body stream’s own error. Map it as you would any mid-stream transport failure (a TransportError keeps its kind, so a stream timeout stays a timeout).

InvalidUtf8(Utf8Error)

A line was not valid UTF-8.

The WHATWG event stream format decodes the stream as UTF-8 and replaces invalid bytes with U+FFFD. This decoder fails instead, on purpose. A browser shows event text to a person; an adapter decodes JSON from it, and a replaced byte changes a string value (generated text, tool arguments, an opaque signature that is replayed later) without anything saying so, which allama never does silently (ADR 0003). Invalid UTF-8 means a broken server or intermediary, and asking again streams the same bytes: map it to a stream decode error (allama::Error::stream_decode), which is not retryable, not to a transport failure. A chunk boundary inside a UTF-8 sequence is not an error: each line is decoded once it is complete.

#[non_exhaustive]

EventTooLarge

A line, or an event’s data, passed the decoder’s size cap (SseDecoder::max_event_size). The stream is not one the caller is prepared to hold, and asking again gets the same answer: map it to a stream protocol error (allama::Error::stream_protocol), not a retryable transport failure.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

limit: usize

The cap, in bytes.

Implementations

impl<E: Into<TransportError>> SseError<E>

pub fn into_error(self) -> Error

The portable error for a failed SSE stream, as the variants say:

• Transport: the body error as a TransportError, mapped by TransportError::into_stream_error, so a stream timeout stays allama::Error::Timeout and any other failed read is a retryable transport stream error, with the transport’s text as the upstream message;
• InvalidUtf8: a stream decode error;
• EventTooLarge: a stream protocol error.

Neither of the last two is retryable, and every message is authored. Add the provider and the request id. SseChatStream::new maps failures with it.

use allama::{Error, StreamErrorKind};
use allama_http::sse::{SseError, SseStream};
use allama_http::{TransportError, TransportErrorKind};
use futures_util::{FutureExt, StreamExt, stream};

let body = stream::iter([Ok::<_, TransportError>(&b"data: \xFF\n\n"[..])]);
let failure = SseStream::new(body).next().now_or_never().flatten().unwrap().unwrap_err();
let err = failure.into_error().with_provider("acme");
assert!(matches!(err, Error::Stream { kind: StreamErrorKind::Decode, .. }));
assert!(!err.is_retryable());

let timeout = SseError::Transport(TransportError::new(TransportErrorKind::Timeout, "idle"));
assert!(matches!(timeout.into_error(), Error::Timeout { .. }));

Trait Implementations

impl<E: Debug> Debug for SseError<E>

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

Formats the value using the given formatter.

impl<E: Display> Display for SseError<E>

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

Formats the value using the given formatter.

impl<E: Eq> Eq for SseError<E>

impl<E: Error + 'static> Error for SseError<E>

fn source(&self) -> Option<&(dyn Error + 'static)>

A transport failure is transparent: its source is the body error’s source.

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<E: Into<TransportError>> From<SseError<E>> for Error

fn from(error: SseError<E>) -> Self

The error SseError::into_error gives: what FramedChatStream::new classifies a failure with.

impl<E: PartialEq> PartialEq for SseError<E>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<E: PartialEq> StructuralPartialEq for SseError<E>