Struct FramedChatStream 

pub struct FramedChatStream<S: TryStream, D> { /* private fields */ }

A chat stream decoded from a response’s frames by an adapter’s ChatFrameDecoder, with the driver guarantees the decoder trait lists.

frames is any stream of Result<frame, error>: an SseStream, an NdjsonStream, or a framer of your own. It is unboxed and Send (for a Send body); box it into a ChatStream with Prepared::finish_stream:

let lines = NdjsonStream::new(response.into_body()).max_line_size(max_stream_event_size);
Ok(prepared.finish_stream(FramedChatStream::new(lines, StreamDecoder::new(request_id))))

Implementations

impl<S: TryStream, D: ChatFrameDecoder<S::Ok>> FramedChatStream<S, D>

pub fn new(frames: S, decoder: D) -> Self

where S::Error: Into<Error> + 'static,

Drive decoder over frames, classifying a failure with its conversion into an allama::Error. The bundled framers’ errors convert for a body whose error converts into a TransportError, as an HttpResponse body’s does (SseError::into_error, NdjsonError::into_error).

pub fn with_error_map<M>(frames: S, decoder: D, map: M) -> Self

where S::Error: 'static, M: FnMut(S::Error) -> Error + Send + 'static,

Drive decoder over frames, classifying a failure with map, for a body whose error is not a TransportError (a platform’s own byte stream). map must keep the rules of the framer’s own classification: a timeout stays a timeout, bytes the framer cannot decode are a stream decode error, a frame past the size cap a stream protocol error, and the messages are the adapter’s own.

Trait Implementations

impl<S: TryStream, D> Debug for FramedChatStream<S, D>

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

Formats the value using the given formatter.

impl<S, F, E, D> Stream for FramedChatStream<S, D>

where S: Stream<Item = Result<F, E>> + Unpin, D: ChatFrameDecoder<F>,

type Item = Result<StreamEvent, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<S: TryStream, D> Unpin for FramedChatStream<S, D>