Struct actix_web_lab::sse::Sse

pub struct Sse<S> { /* private fields */ }

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

Constructed with an SSE channel or using your own stream.

Implementations

impl<S, E> Sse<S>

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

pub fn from_stream(stream: S) -> Self

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

impl<S> Sse<S>

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.

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

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

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

Formats the value using the given formatter.

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.

fn size(&self) -> BodySize

Body size hint.

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.

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

where Self: Sized,

Try to convert into the complete chunk of body bytes.

fn boxed(self) -> BoxBody

where Self: Sized + 'static,

Wraps this body into a BoxBody.

impl<S, E> Responder for Sse<S>

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

type Body = BoxBody

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

Convert self to HttpResponse.

fn customize(self) -> CustomizeResponder<Self>

where Self: Sized,

Wraps responder to allow alteration of its response.

impl<'__pin, S> Unpin for Sse<S>

where PinnedFieldsOf<__Origin<'__pin, S>>: Unpin,