[][src]Struct salvo_extra::sse::SseKeepAlive

pub struct SseKeepAlive<S> { /* fields omitted */ }

Implementations

impl<S> SseKeepAlive<S> where
    S: TryStream<Ok = SseEvent> + Send + 'static,
    S::Error: StdError + Send + Sync + 'static, 
[src]

pub fn new(event_stream: S) -> SseKeepAlive<S>[src]

pub fn interval(mut self: Self, time: Duration) -> Self[src]

Customize the interval between keep-alive messages.

Default is 15 seconds.

pub fn text(mut self: Self, text: impl Into<Cow<'static, str>>) -> Self[src]

Customize the text of the keep-alive message.

Default is an empty comment.

pub fn streaming(self, res: &mut Response)[src]

Wrap an event stream with keep-alive functionality.

See keep_alive for more.

Trait Implementations

impl<S> Stream for SseKeepAlive<S> where
    S: TryStream<Ok = SseEvent> + Send + 'static,
    S::Error: StdError + Send + Sync + 'static, 
[src]

type Item = Result<SseEvent, SseError>

Values yielded by the stream.

impl<'pin, S> Unpin for SseKeepAlive<S> where
    __SseKeepAlive<'pin, S>: Unpin
[src]

Auto Trait Implementations

impl<S> !RefUnwindSafe for SseKeepAlive<S>[src]

impl<S> Send for SseKeepAlive<S> where
    S: Send
[src]

impl<S> Sync for SseKeepAlive<S> where
    S: Sync
[src]

impl<S> !UnwindSafe for SseKeepAlive<S>[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> StreamExt for T where
    T: Stream + ?Sized

impl<St> StreamExt for St where
    St: Stream + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>> + ?Sized

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

impl<S> TryStreamExt for S where
    S: TryStream + ?Sized

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

impl<T> WithSubscriber for T[src]