Struct Events 

pub struct Events { /* private fields */ }

The events of a text/event-stream body, as they come. A data: [DONE] event ends it, as does the end of the body or a failure reading it (yielded as Err first); the body is dropped then, which frees the connection.

Implementations

impl Events

pub fn from_response(response: Response) -> Self

The events of a response body. The status and the content type are not checked.

pub fn from_bytes<S, B>(bytes: S) -> Self

where S: Stream<Item = Result<B, Error>> + MaybeSend + 'static, B: AsRef<[u8]> + MaybeSend + 'static,

The events of a body read as a stream of chunks. The stream and its chunks must be Send, except on WebAssembly (MaybeSend).

pub fn idle_timeout(self, limit: Duration) -> Self

Available on crate feature time only.

Ends the stream with an error when no bytes arrive for limit: a server or a proxy that keeps the connection open but stopped sending. The error (Error::is_timeout and Error::is_body) is the last item, and the body is dropped. Every chunk restarts the clock, comments (: keep-alive) too; there is no limit on the whole stream. Feature time; the timer is tokio’s, or the JavaScript host’s setTimeout on WebAssembly.

use std::time::Duration;

let events = response.events().idle_timeout(Duration::from_secs(300));

impl Events

pub fn json<T: DeserializeOwned>(self) -> JsonEvents<T>

Decodes the data: payload of every event as JSON, to T.

A payload that does not decode yields an error for which Error::is_decode is true, and the stream goes on with the next event; an event with an empty payload yields nothing. A failure reading the body yields an error and ends the stream.

Trait Implementations

impl Debug for Events

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

Formats the value using the given formatter.

impl Stream for Events

type Item = Result<Event, 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.