Struct Data

pub struct Data { /* private fields */ }

Server-sent events data message containing a data field and optional id and event fields.

Since it implements Into<SseMessage>, this can be passed directly to send or try_send.

Examples

use std::convert::Infallible;

use actix_web::body;
use actix_web_lab::sse;
use futures_util::stream;
use serde::Serialize;

#[derive(serde::Serialize)]
struct Foo {
    bar: u32,
}

let sse = sse::Sse::from_stream(stream::iter([
    Ok::<_, Infallible>(sse::Event::Data(sse::Data::new("foo"))),
    Ok::<_, Infallible>(sse::Event::Data(
        sse::Data::new_json(Foo { bar: 42 }).unwrap(),
    )),
]));

assert_eq!(
    body::to_bytes(sse).await.unwrap(),
    "data: foo\n\ndata: {\"bar\":42}\n\n",
);

Implementations

impl Data

pub fn new(data: impl Into<ByteString>) -> Self

Constructs a new SSE data message with just the data field.

Examples

use actix_web_lab::sse;
let event = sse::Event::Data(sse::Data::new("foo"));

pub fn new_json(data: impl Serialize) -> Result<Self, Error>

Constructs a new SSE data message the data field set to data serialized as JSON.

Examples

use actix_web_lab::sse;

#[derive(serde::Serialize)]
struct Foo {
    bar: u32,
}

let event = sse::Event::Data(sse::Data::new_json(Foo { bar: 42 }).unwrap());

pub fn set_data(&mut self, data: impl Into<ByteString>)

Sets data field.

pub fn id(self, id: impl Into<ByteString>) -> Self

Sets id field, returning a new data message.

pub fn set_id(&mut self, id: impl Into<ByteString>)

Sets id field.

pub fn event(self, event: impl Into<ByteString>) -> Self

Sets event name field, returning a new data message.

pub fn set_event(&mut self, event: impl Into<ByteString>)

Sets event name field.

Trait Implementations

impl Clone for Data

fn clone(&self) -> Data

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Data

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

Formats the value using the given formatter.

impl From<Data> for Event

fn from(data: Data) -> Self

Converts to this type from the input type.