Struct KeepAlive 

pub struct KeepAlive<T = String> { /* private fields */ }

Configure the interval between keep-alive messages, the content of each message, and the associated stream.

Implementations

impl<T> KeepAlive<T>

pub fn new() -> KeepAlive<T>

Create a new KeepAlive.

The default frame is a single empty comment, which serializes to :\n\n on the wire — the canonical SSE keep-alive payload. A fully empty Event would serialize to zero bytes and convey nothing to the client (some HTTP/2 stacks also reject empty data frames).

impl<T> KeepAlive<T>

where T: EventDataWrite,

pub fn with_interval(self, time: Duration) -> KeepAlive<T>

Customize the interval between keep-alive messages.

Default is 15 seconds.

pub fn set_interval(&mut self, time: Duration) -> &mut KeepAlive<T>

Customize the interval between keep-alive messages.

Default is 15 seconds.

pub fn try_with_text( self, text: impl Into<SmolStr>, ) -> Result<KeepAlive<T>, Box<dyn Error + Send + Sync>>

Customize the text of the keep-alive message.

Default is an empty comment.

pub fn try_set_text( &mut self, text: impl Into<SmolStr>, ) -> Result<&mut KeepAlive<T>, Box<dyn Error + Send + Sync>>

Customize the text of the keep-alive message.

Default is an empty comment.

pub fn with_event(self, event: Event<T>) -> KeepAlive<T>

Customize the event of the keep-alive message.

Default is an empty event.

pub fn set_event(&mut self, event: Event<T>) -> &mut KeepAlive<T>

Customize the event of the keep-alive message.

Default is an empty event.

Trait Implementations

impl<T> Clone for KeepAlive<T>

where T: Clone,

fn clone(&self) -> KeepAlive<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for KeepAlive<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for KeepAlive<T>

fn default() -> KeepAlive<T>

Returns the “default value” for a type.