Skip to main content

Sse

Struct Sse 

Source
pub struct Sse { /* private fields */ }
Expand description

Builder for a buffered Server-Sent Events response.

Call Sse::into_response to obtain a Response with:

  • 200 OK
  • Content-Type: text/event-stream
  • Cache-Control: no-cache
  • X-Accel-Buffering: no (disables nginx proxy buffering)

§Example

use rust_web_server::sse::Sse;

let response = Sse::new()
    .event("open", "")
    .data(r#"{"msg":"hello"}"#)
    .retry(5000)
    .into_response();

Implementations§

Source§

impl Sse

Source

pub fn new() -> Self

Create an empty SSE response builder.

Source

pub fn event(self, event_type: &str, data: &str) -> Self

Append a named event with data.

event_type becomes the event: field; data becomes the data: field.

Source

pub fn data(self, data: &str) -> Self

Append a data-only event (no event: type field; clients receive it as "message").

Source

pub fn push(self, event: SseEvent) -> Self

Append a fully configured SseEvent (id, type, retry, data).

Source

pub fn retry(self, ms: u32) -> Self

Append a retry: directive that tells the client how many milliseconds to wait before reconnecting after the connection is lost.

Source

pub fn comment(self, text: &str) -> Self

Append an SSE comment line (starts with :). Used as a keep-alive ping or annotation; browsers ignore comment content.

Source

pub fn into_response(self) -> Response

Finalise the builder and return a Response with the correct SSE headers and the accumulated event body.

Auto Trait Implementations§

§

impl Freeze for Sse

§

impl RefUnwindSafe for Sse

§

impl Send for Sse

§

impl Sync for Sse

§

impl Unpin for Sse

§

impl UnsafeUnpin for Sse

§

impl UnwindSafe for Sse

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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