Struct Events 

pub struct Events { /* private fields */ }

The event notifier of one request, job batch or cron run: Ctx::events.

Cheap to clone; clones share their context and pending events. Events::default() builds one for unit tests, whose events are read back with take.

Examples

let events = ocre::events::Events::default();
events.notify("cache.miss", "posts/12");
assert_eq!(events.take()[0].payload["value"], "posts/12");

Implementations

impl Events

pub fn notify(&self, name: &str, payload: impl Serialize)

Records an event (Rails’ Rails.event.notify): logs it and queues it for the subscribers.

Examples

let events = ocre::events::Events::default();
events.notify("post.published", serde_json::json!({ "post_id": 3 }));
assert_eq!(events.take()[0].payload["post_id"], 3);

pub fn tagged(&self, key: &str, value: impl Serialize) -> Self

This notifier with a tag added to its events (Rails’ Rails.event.tagged).

Examples

let events = ocre::events::Events::default();
events.tagged("importer", "csv").notify("row.skipped", serde_json::json!({ "line": 12 }));
assert_eq!(events.take()[0].tags["importer"], "csv");

pub fn set_context(&self, key: &str, value: impl Serialize)

Adds context to every later event of this request or job (Rails’ Rails.event.set_context).

Examples

let events = ocre::events::Events::default();
events.set_context("user_id", 7);
events.notify("search", serde_json::json!({ "query": "rust" }));
assert_eq!(events.take()[0].context["user_id"], 7);

pub fn take(&self) -> Vec<Event>

Takes the events not yet sent to the subscribers, oldest first.

Examples

let events = ocre::events::Events::default();
events.notify("a", ());
assert_eq!(events.take().len(), 1);
assert!(events.take().is_empty());

Trait Implementations

impl Clone for Events

fn clone(&self) -> Events

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Events

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

Formats the value using the given formatter.

impl Default for Events

fn default() -> Events

Returns the “default value” for a type.