Struct trillium_channels::ChannelEvent

pub struct ChannelEvent { /* private fields */ }

The messages passed between server and connected clients.

ChannelEvents contain a topic, event, payload, and if sent from a client, a unique reference identifier that can be used to respond to this event.

Most interfaces in this crate take an Into<ChannelEvent> instead of a ChannelEvent directly, so that you can either implement Into for relevant types, or use these tuple From implementations:

use trillium_channels::ChannelEvent;
use serde_json::{json, Value, to_string};
let event: ChannelEvent = ("topic", "event").into();
assert_eq!(event.topic(), "topic");
assert_eq!(event.event(), "event");
assert_eq!(event.payload(), &json!({}));

let event: ChannelEvent = ("topic", "event", &json!({"some": "payload"})).into();
assert_eq!(event.topic(), "topic");
assert_eq!(event.event(), "event");
assert_eq!(to_string(event.payload()).unwrap(), r#"{"some":"payload"}"#);

#[derive(serde::Serialize)]
struct SomePayload { payload: &'static str };
let event: ChannelEvent = ("topic", "event", &SomePayload { payload: "anything" }).into();
assert_eq!(event.topic(), "topic");
assert_eq!(event.event(), "event");
assert_eq!(to_string(event.payload()).unwrap(), r#"{"payload":"anything"}"#);

Implementations

impl ChannelEvent

pub fn build_reply( &self, event: impl Into<Cow<'static, str>>, payload: &impl Serialize, ) -> ChannelEvent

Construct a new ChannelEvent with the same reference as this ChannelEvent. Note that this is the only way of setting the reference on an event.

The event argument can be either a String or, more commonly, a &'static str.

The topic will always be the same as the source ChannelEvent’s topic.

pub fn topic(&self) -> &str

Returns this ChannelEvent’s topic

pub fn event(&self) -> &str

Returns this ChannelEvent’s event

pub fn payload(&self) -> &Value

Returns this ChannelEvent’s payload as a Value

pub fn reference(&self) -> Option<&str>

Returns the reference field (“ref” in json) for this ChannelEvent, if one was provided by the client

pub fn new( topic: impl Into<Cow<'static, str>>, event: impl Into<Cow<'static, str>>, payload: &impl Serialize, ) -> Self

Constructs a new ChannelEvent from topic, event, and a serializable payload. Use &() if no payload is needed.

Note that the reference cannot be set this way. To set a reference, use ChannelEvent::build_reply

Trait Implementations

impl Clone for ChannelEvent

fn clone(&self) -> ChannelEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, E> From<(T, E)> for ChannelEvent

where T: Into<Cow<'static, str>>, E: Into<Cow<'static, str>>,

fn from(te: (T, E)) -> Self

Converts to this type from the input type.

impl<T, E, P> From<(T, E, P)> for ChannelEvent

where T: Into<Cow<'static, str>>, E: Into<Cow<'static, str>>, P: Serialize,

fn from(tep: (T, E, P)) -> Self

Converts to this type from the input type.

impl PartialEq for ChannelEvent

fn eq(&self, other: &ChannelEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ChannelEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ChannelEvent

impl StructuralPartialEq for ChannelEvent