actix-sse 0.1.0

Actix-web SSE implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

use bytestring::ByteString;

/// Server-sent events data message containing a `data` field and optional `id` and `event` fields.
#[must_use]
#[derive(Debug, Clone)]
pub struct Data {
    pub(crate) id: Option<ByteString>,
    pub(crate) event: Option<ByteString>,
    pub(crate) data: ByteString,
}

impl Data {
    /// Constructs a new SSE data message with just the `data` field.
    ///
    /// # Examples
    /// ```
    /// let event = actix_sse::Event::Data(actix_sse::Data::new("foo"));
    /// ```
    pub fn new<T: Into<ByteString>>(data: T) -> Self {
        Self {
            id: None,
            event: None,
            data: data.into(),
        }
    }

    /// Sets `id` field, returning a new data message.
    pub fn id(mut self, id: impl Into<ByteString>) -> Self {
        self.id = Some(id.into());
        self
    }

    /// Sets `event` name field, returning a new data message.
    pub fn event(mut self, event: impl Into<ByteString>) -> Self {
        self.event = Some(event.into());
        self
    }
}