Struct NotificationEvent 

pub struct NotificationEvent {
    pub kind: NotificationKind,
    pub actor: UserId,
    pub actor_is_agent: bool,
    pub via_agent: Option<String>,
    pub subjects: Vec<SubjectRef>,
    pub stream: Option<NotificationStreamId>,
    pub direct_recipients: Vec<DirectRecipient>,
    pub sender_attention: Option<Attention>,
    pub excerpt: Option<String>,
    pub payload: Value,
    pub occurred_at: DateTime<Utc>,
}

One thing that happened, before routing decides who hears about it.

Fields

kind: NotificationKind

actor: UserId

actor_is_agent: bool

via_agent: Option<String>

subjects: Vec<SubjectRef>

stream: Option<NotificationStreamId>

direct_recipients: Vec<DirectRecipient>

sender_attention: Option<Attention>

excerpt: Option<String>

payload: Value

occurred_at: DateTime<Utc>

Implementations

impl NotificationEvent

pub const fn new( kind: NotificationKind, actor: UserId, occurred_at: DateTime<Utc>, ) -> Self

pub const fn with_actor_is_agent(self, actor_is_agent: bool) -> Self

pub fn with_via_agent(self, via_agent: impl Into<String>) -> Self

pub fn with_subject(self, subject: SubjectRef) -> Self

pub fn with_subjects( self, subjects: impl IntoIterator<Item = SubjectRef>, ) -> Self

pub fn with_stream(self, stream: NotificationStreamId) -> Self

pub fn with_direct_recipient( self, user: UserId, attention: Option<Attention>, ) -> Self

pub fn with_direct_recipients( self, recipients: impl IntoIterator<Item = DirectRecipient>, ) -> Self

pub const fn with_sender_attention(self, attention: Attention) -> Self

pub fn with_excerpt(self, excerpt: impl Into<String>) -> Self

pub fn with_payload(self, payload: Value) -> Self

Trait Implementations

impl Clone for NotificationEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotificationEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NotificationEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for NotificationEvent

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for NotificationEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for NotificationEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NotificationEvent