Skip to main content

SseResponse

Struct SseResponse 

Source
pub struct SseResponse<S> { /* private fields */ }
Expand description

Builder for creating SSE responses.

§Example

use fastapi_core::sse::{SseEvent, SseResponse};
use asupersync::stream;

async fn events() -> Response {
    let events = stream::iter(vec![
        SseEvent::message("Hello"),
        SseEvent::message("World"),
    ]);

    SseResponse::new(events)
        .into_response()
}

Implementations§

Source§

impl<S> SseResponse<S>
where S: Stream<Item = SseEvent> + Send + Unpin + 'static,

Source

pub fn new(stream: S) -> Self

Create a new SSE response from an event stream.

Source

pub fn with_config(stream: S, config: SseConfig) -> Self

Create an SSE response with custom configuration.

Source

pub fn into_response(self) -> Response

Convert to an HTTP Response.

Sets the appropriate headers for SSE:

  • Content-Type: text/event-stream
  • Cache-Control: no-cache
  • Connection: keep-alive

Auto Trait Implementations§

§

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

§

impl<S> RefUnwindSafe for SseResponse<S>
where S: RefUnwindSafe,

§

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

§

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

§

impl<S> Unpin for SseResponse<S>
where S: Unpin,

§

impl<S> UnwindSafe for SseResponse<S>
where S: 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: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> 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<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
Source§

impl<T> ResponseProduces<T> for T