Struct Event 

pub struct Event<P = Value> {
    pub protocol: String,
    pub kind: String,
    pub actor: AgentId,
    pub created_at: i64,
    pub nonce: u64,
    pub room_id: Option<String>,
    pub base_seq: Option<u64>,
    pub base_hash: Option<String>,
    pub mentions: Option<Vec<AgentId>>,
    pub payload: P,
    pub extra: BTreeMap<String, Value>,
}

Fields

protocol: String

kind: String

actor: AgentId

created_at: i64

nonce: u64

room_id: Option<String>

base_seq: Option<u64>

base_hash: Option<String>

mentions: Option<Vec<AgentId>>

None when the field is absent. An explicit empty list is kept, so a deserialized event re-serializes to the bytes that were signed.

payload: P

extra: BTreeMap<String, Value>

Unknown top-level fields, kept so the event hashes as signed. Protocol validators reject them (the closed event object, Section 5.1).

Implementations

impl<P> Event<P>

pub fn new( protocol: impl Into<String>, kind: impl Into<String>, actor: AgentId, created_at: i64, nonce: u64, payload: P, ) -> Self

pub fn with_room_id(self, room_id: impl Into<String>) -> Self

pub fn with_room_head(self, base_seq: u64, base_hash: impl Into<String>) -> Self

pub fn with_mentions(self, mentions: Vec<AgentId>) -> Self

pub fn with_mention(self, agent_id: AgentId) -> Self

pub fn mentions(&self) -> &[AgentId]

The event’s mentions, empty when the field is absent.

Trait Implementations

impl<P: Clone> Clone for Event<P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for Event<P>

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

Formats the value using the given formatter.

impl<'de, P> Deserialize<'de> for Event<P>

where P: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P: PartialEq> PartialEq for Event<P>

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

Equality operator ==.

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

Inequality operator !=.

impl<P> Serialize for Event<P>

where P: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<P: PartialEq> StructuralPartialEq for Event<P>