Struct actix_web_lab::sse::Sse

source ·
pub struct Sse<S> { /* private fields */ }
Expand description

Server-sent events (text/event-stream) responder.

Constructed with an SSE channel or using your own stream.

Implementations§

source§

impl<S, E> Sse<S>
where S: Stream<Item = Result<Event, E>> + 'static, E: Into<Box<dyn Error>>,

source

pub fn from_stream(stream: S) -> Self

Create an SSE response from a stream that yields SSE Events.

source§

impl<S> Sse<S>

source

pub fn with_keep_alive(self, keep_alive_period: Duration) -> Self

Enables “keep-alive” messages to be send in the event stream after a period of inactivity.

By default, no keep-alive is set up.

source

pub fn with_retry_duration(self, retry: Duration) -> Self

Queues first event message to inform client of custom retry period.

Browsers default to retry every 3 seconds or so.

Trait Implementations§

source§

impl<S: Debug> Debug for Sse<S>

source§

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

Formats the value using the given formatter. Read more
source§

impl<S, E> MessageBody for Sse<S>
where S: Stream<Item = Result<Event, E>>, E: Into<Box<dyn Error>>,

§

type Error = Box<dyn Error>

The type of error that will be returned if streaming body fails. Read more
source§

fn size(&self) -> BodySize

Body size hint. Read more
source§

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

Attempt to pull out the next chunk of body bytes. Read more
source§

fn try_into_bytes(self) -> Result<Bytes, Self>
where Self: Sized,

Try to convert into the complete chunk of body bytes. Read more
source§

fn boxed(self) -> BoxBody
where Self: Sized + 'static,

Wraps this body into a BoxBody. Read more
source§

impl<S, E> Responder for Sse<S>
where S: Stream<Item = Result<Event, E>> + 'static, E: Into<Box<dyn Error>>,

§

type Body = BoxBody

source§

fn respond_to(self, _req: &HttpRequest) -> HttpResponse<Self::Body>

Convert self to HttpResponse.
source§

fn customize(self) -> CustomizeResponder<Self>
where Self: Sized,

Wraps responder to allow alteration of its response. Read more
source§

impl<'__pin, S> Unpin for Sse<S>
where __Origin<'__pin, S>: Unpin,

Auto Trait Implementations§

§

impl<S> Freeze for Sse<S>
where S: Freeze,

§

impl<S> !RefUnwindSafe for Sse<S>

§

impl<S> Send for Sse<S>
where S: Send,

§

impl<S> Sync for Sse<S>
where S: Sync,

§

impl<S> !UnwindSafe for Sse<S>

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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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