Skip to main content

SseReader

volo_http::client::sse

Struct SseReader 

Source 
pub struct SseReader<B> { /* private fields */ }
Available on crate feature client only.
Expand description

A reader for SSE response body.

Wraps a streaming response body and parses it into SseEvents.

Implementations§

Source§

impl<B> SseReader<B>
where B: Body<Data = Bytes> + Unpin, B::Error: Into<BoxError>,

Source

pub fn into_sse(resp: Response<B>) -> Result<Self, BoxError>

Create a new SSE reader from an HTTP response.

Source

pub fn last_event_id(&self) -> &str

Returns the last event ID received, for use as Last-Event-ID on reconnection.

Empty string means the server explicitly cleared it.

Source

pub async fn read(&mut self) -> Result<Option<SseEvent>, BoxError>

Read the next SSE event from the stream.

Returns Ok(Some(event)) when an event is ready, Ok(None) when the stream is exhausted, or Err on a transport or parse error.

Auto Trait Implementations§

§

impl<B> Freeze for SseReader<B>
where B: Freeze,

§

impl<B> RefUnwindSafe for SseReader<B>
where B: RefUnwindSafe,

§

impl<B> Send for SseReader<B>
where B: Send,

§

impl<B> Sync for SseReader<B>
where B: Sync,

§

impl<B> Unpin for SseReader<B>
where B: Unpin,

§

impl<B> UnsafeUnpin for SseReader<B>
where B: UnsafeUnpin,

§

impl<B> UnwindSafe for SseReader<B>
where B: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more