Struct actix_web_lab::sse::Sender

pub struct Sender { /* private fields */ }

Sender half of a server-sent events stream.

Implementations

impl Sender

pub async fn send(&self, msg: impl Into<Event>) -> Result<(), SendError>

Send an SSE message.

Errors

Errors if the receiving (Sse) has been dropped, likely because the client disconnected.

Examples

#[actix_web::main] async fn test() {
use actix_web_lab::sse;

let (sender, sse_stream) = sse::channel(5);
sender.send(sse::Data::new("my data").event("my event name")).await.unwrap();
sender.send(sse::Event::Comment("my comment".into())).await.unwrap();

pub fn try_send(&self, msg: impl Into<Event>) -> Result<(), TrySendError>

Tries to send SSE message.

Errors

Errors if:

• the the SSE buffer is currently full;
• the receiving (Sse) has been dropped, likely because the client disconnected.

Examples

#[actix_web::main] async fn test() {
use actix_web_lab::sse;

let (sender, sse_stream) = sse::channel(5);
sender.try_send(sse::Data::new("my data").event("my event name")).unwrap();
sender.try_send(sse::Event::Comment("my comment".into())).unwrap();

Trait Implementations

impl Clone for Sender

fn clone(&self) -> Sender

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sender

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

Formats the value using the given formatter.