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>>,
impl<S, E> Sse<S>where S: Stream<Item = Result<Event, E>> + 'static, E: Into<Box<dyn Error>>,
sourcepub fn from_stream(stream: S) -> Self
pub fn from_stream(stream: S) -> Self
Create an SSE response from a stream that yields SSE Events.
source§impl<S> Sse<S>
impl<S> Sse<S>
sourcepub fn with_keep_alive(self, keep_alive_period: Duration) -> Self
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.
sourcepub fn with_retry_duration(self, retry: Duration) -> Self
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, E> MessageBody for Sse<S>where
S: Stream<Item = Result<Event, E>>,
E: Into<Box<dyn Error>>,
impl<S, E> MessageBody for Sse<S>where S: Stream<Item = Result<Event, E>>, E: Into<Box<dyn Error>>,
§type Error = Box<dyn Error, Global>
type Error = Box<dyn Error, Global>
The type of error that will be returned if streaming body fails. Read more
source§fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Bytes, Self::Error>>>
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§impl<S, E> Responder for Sse<S>where
S: Stream<Item = Result<Event, E>> + 'static,
E: Into<Box<dyn Error>>,
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>
fn respond_to(self, _req: &HttpRequest) -> HttpResponse<Self::Body>
Convert self to
HttpResponse
.impl<'__pin, S> Unpin for Sse<S>where __Origin<'__pin, S>: Unpin,
Auto Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more