Struct axum::response::sse::Sse

source · [−]

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

Expand description

An SSE response

Implementations

source

impl<S> Sse<S>

source

pub fn new(stream: S) -> Self where
S: TryStream<Ok = Event> + Send + 'static,
S::Error: Into<BoxError>,

Create a new Sse response that will respond with the given stream of Events.

See the module docs for more details.

source

pub fn keep_alive(self, keep_alive: KeepAlive) -> Self

Configure the interval between keep-alive messages.

Defaults to no keep-alive messages.

Trait Implementations

source

impl<S: Clone> Clone for Sse<S>

source

fn clone(&self) -> Sse<S>

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<S> 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> IntoResponse for Sse<S> where
S: Stream<Item = Result<Event, E>> + Send + 'static,
E: Into<BoxError>,

source

fn into_response(self) -> Response

Create a response.

Auto Trait Implementations

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

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

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

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

impl<S> UnwindSafe for Sse<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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

Struct axum::response::sse::Sse

Implementations

impl<S> Sse<S>

pub fn new(stream: S) -> Self where S: TryStream<Ok = Event> + Send + 'static, S::Error: Into<BoxError>,

pub fn keep_alive(self, keep_alive: KeepAlive) -> Self

Trait Implementations

impl<S: Clone> Clone for Sse<S>

fn clone(&self) -> Sse<S>

fn clone_from(&mut self, source: &Self)

impl<S> Debug for Sse<S>

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

impl<S, E> IntoResponse for Sse<S> where S: Stream<Item = Result<Event, E>> + Send + 'static, E: Into<BoxError>,

fn into_response(self) -> Response

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

pub fn new(stream: S) -> Self where
S: TryStream<Ok = Event> + Send + 'static,
S::Error: Into<BoxError>,

impl<S, E> IntoResponse for Sse<S> where
S: Stream<Item = Result<Event, E>> + Send + 'static,
E: Into<BoxError>,

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

impl<T> ToOwned for T where
T: Clone,

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,