Struct axum::response::sse::KeepAlive

pub struct KeepAlive { /* private fields */ }

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

Implementations

impl KeepAlive

pub fn new() -> Self

Create a new KeepAlive.

pub fn interval(self, time: Duration) -> Self

Customize the interval between keep-alive messages.

Default is 15 seconds.

pub fn text<I>(self, text: I) -> Self

where I: AsRef<str>,

Customize the text of the keep-alive message.

Default is an empty comment.

Panics

Panics if text contains any newline or carriage returns, as they are not allowed in SSE comments.

pub fn event(self, event: Event) -> Self

Customize the event of the keep-alive message.

Default is an empty comment.

Panics

Panics if event contains any newline or carriage returns, as they are not allowed in SSE comments.

Trait Implementations

impl Clone for KeepAlive

fn clone(&self) -> KeepAlive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeepAlive

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

Formats the value using the given formatter.

impl Default for KeepAlive

fn default() -> Self

Returns the “default value” for a type.