Struct pushevent::Event

pub struct Event { /* fields omitted */ }

Base Event struct which can be sent across a channel provided by Server::get_tx. This struct encapsulates a inner trait object and res which is the resource we want to target.

Methods

impl Event

pub fn new(res: String, inner: Box<dyn SerializableEvent>) -> Self

Returns a Event instance.

Arguments

• res - A string slice that holds the resource we want to target
• inner - A boxed trait object that can serialize to a string.

Example

use pushevent::{Event, SerializableEvent};
struct Message;

impl SerializableEvent for Message {
    fn serialize(&self) -> String {
        String::from("Hello world")
    }
}

let message = Box::new(Message);
let new_event = Event::new("/events/message", message);

assert_eq!(new_event.get_res(), String::from("/events/message"));
assert_eq!(new_event.build(), String::from("Hello world"));

pub fn get_res(&self) -> String

Returns the resource path that this event targets. Usually used internally and rarely useful.

Example

use pushevent::{Event, SerializableEvent};
struct Message;

impl SerializableEvent for Message {
    fn serialize(&self) -> String {
        String::from("Hello world")
    }
}

let message = Box::new(Message);
let new_event = Event::new("/events/message", message);

assert_eq!(new_event.get_res(), String::from("/events/message"));

pub fn build(&self) -> String

Serializes and returns the inner event/message.

Example

use pushevent::{Event, SerializableEvent};
struct Message;

impl SerializableEvent for Message {
    fn serialize(&self) -> String {
        String::from("Hello world")
    }
}

let message = Box::new(Message);
let new_event = Event::new("/events/message", message);
assert_eq!(new_event.build(), String::from("Hello world"));