Struct actix_web_lab::sse::Data

source ·
pub struct Data { /* private fields */ }
Expand description

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§

source§

impl Data

source

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"));
source

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());
source

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

Sets data field.

source

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

Sets id field, returning a new data message.

source

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

Sets id field.

source

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

Sets event name field, returning a new data message.

source

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

Sets event name field.

Trait Implementations§

source§

impl Clone for Data

source§

fn clone(&self) -> Data

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Data

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Data> for Event

source§

fn from(data: Data) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !Freeze for Data

§

impl RefUnwindSafe for Data

§

impl Send for Data

§

impl Sync for Data

§

impl Unpin for Data

§

impl UnwindSafe for Data

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

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

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more