Struct Event 

#[non_exhaustive]
pub struct Event {
    pub action: Action,
    pub author: String,
    pub date: DateTime<Utc>,
    pub mechanism: Mechanism,
    pub metadata: Value,
    pub object: String,
    pub object_id: String,
    pub author_anonymous: Option<bool>,
    pub author_ip: Option<String>,
    pub author_role: Option<String>,
    pub author_user_agent: Option<String>,
    pub session_id: Option<String>,
}

A Tracks event to publish.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

action: Action

author: String

date: DateTime<Utc>

mechanism: Mechanism

metadata: Value

Arbitrary JSON object with additional event context.

Must be a JSON object (i.e. serde_json::json!({ "key": "value" })). Passing a non-object value (array, string, number, …) will cause the event to be silently dropped when EventResource::create is called.

object: String

object_id: String

author_anonymous: Option<bool>

author_ip: Option<String>

author_role: Option<String>

author_user_agent: Option<String>

session_id: Option<String>

Implementations

impl Event

pub fn new( action: Action, author: String, date: DateTime<Utc>, mechanism: Mechanism, metadata: Value, object: String, object_id: String, ) -> Self

Create a new event with required fields. Optional fields default to None.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Serialize for Event

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

where __S: Serializer,

Serialize this value into the given Serde serializer.