Struct Pdu 

pub struct Pdu {

    pub kind: TimelineEventType,
    pub content: Content,
    pub event_id: OwnedEventId,
    pub room_id: OwnedRoomId,
    pub sender: OwnedUserId,
    pub state_key: Option<StateKey>,
    pub redacts: Option<OwnedEventId>,
    pub prev_events: PrevEvents,
    pub auth_events: AuthEvents,
    pub origin_server_ts: UInt,
    pub depth: UInt,
    pub hashes: EventHash,
    pub origin: Option<OwnedServerName>,
    pub unsigned: Option<Box<RawValue>>,
    pub signatures: Option<Box<RawValue>>,
}

Persistent Data Unit (Event)

Fields

kind: TimelineEventType

content: Content

event_id: OwnedEventId

room_id: OwnedRoomId

sender: OwnedUserId

state_key: Option<StateKey>

redacts: Option<OwnedEventId>

prev_events: PrevEvents

auth_events: AuthEvents

origin_server_ts: UInt

depth: UInt

hashes: EventHash

origin: Option<OwnedServerName>

unsigned: Option<Box<RawValue>>

signatures: Option<Box<RawValue>>

Implementations

impl Pdu

pub fn remove_transaction_id(&mut self) -> Result

impl Pdu

pub fn add_age(&mut self) -> Result

impl Pdu

pub fn add_membership(&mut self, membership: &MembershipState) -> Result

MSC4115: annotate the served event with the requesting user’s room membership at the time of the event.

impl Pdu

pub fn add_relation(&mut self, name: &str, pdu: Option<&Pdu>) -> Result

impl Pdu

pub fn from_object_and_roomid_and_eventid( room_id: &RoomId, event_id: &EventId, json: CanonicalJsonObject, ) -> Result<Self>

pub fn from_object_and_eventid( event_id: &EventId, json: CanonicalJsonObject, ) -> Result<Self>

pub fn from_object_federation( room_id: &RoomId, event_id: &EventId, json: CanonicalJsonObject, rules: &RoomVersionRules, ) -> Result<(Self, CanonicalJsonObject)>

pub fn from_object_checked( json: CanonicalJsonObject, rules: &RoomVersionRules, ) -> Result<Self>

pub fn from_object(json: CanonicalJsonObject) -> Result<Self>

pub fn from_raw_value(json: &RawJsonValue) -> Result<Self>

pub fn from_value(json: CanonicalJsonValue) -> Result<Self>

pub fn from_raw_json(json: &RawJsonValue) -> Result<Self>

Trait Implementations

impl Clone for Pdu

fn clone(&self) -> Pdu

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pdu

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Pdu

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Event for &Pdu

where Self: Send,

fn auth_events( &self, ) -> impl DoubleEndedIterator<Item = &EventId> + Clone + Send + '_

All the authenticating events for this event.

fn auth_events_into( self, ) -> impl IntoIterator<IntoIter = impl Iterator<Item = OwnedEventId>> + Send

All the authenticating events for this event.

fn content(&self) -> &RawJsonValue

The event’s content.

fn event_id(&self) -> &EventId

The EventId of this event.

fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch

The time of creation on the originating server.

fn prev_events( &self, ) -> impl DoubleEndedIterator<Item = &EventId> + Clone + Send + '_

The events before this event.

fn redacts(&self) -> Option<&EventId>

If this event is a redaction event this is the event it redacts.

fn rejected(&self) -> bool

see: https://spec.matrix.org/v1.14/rooms/v11/#rejected-events

fn room_id(&self) -> &RoomId

The RoomId of this event.

fn sender(&self) -> &UserId

The UserId of this event.

fn state_key(&self) -> Option<&str>

The state key for this event.

fn kind(&self) -> &TimelineEventType

The event type.

fn unsigned(&self) -> Option<&RawJsonValue>

Metadata container; peer-trusted only.

fn as_pdu(&self) -> &Pdu

fn into_pdu(self) -> Pdu

fn is_owned(&self) -> bool

fn is_type_and_state_key( &self, kind: &TimelineEventType, state_key: &str, ) -> bool

fn into_format<T>(self) -> T

where T: From<Owned<Self>>, Self: Sized,

Serialize into a Ruma JSON format, consuming.

fn to_format<'a, T>(&'a self) -> T

where T: From<Ref<'a, Self>>, Self: Sized + 'a,

Serialize into a Ruma JSON format

fn contains_unsigned_property<T>(&self, property: &str, is_type: T) -> bool

where T: FnOnce(&JsonValue) -> bool, Self: Sized,

fn get_unsigned_property<T>(&self, property: &str) -> Result<T>

where T: for<'de> Deserialize<'de>, Self: Sized,

fn get_unsigned_as_value(&self) -> JsonValue

where Self: Sized,

fn get_unsigned<T>(&self) -> Result<T>

where T: for<'de> Deserialize<'de>, Self: Sized,

fn get_content_as_value(&self) -> JsonValue

where Self: Sized,

fn get_content<T>(&self) -> Result<T>

where for<'de> T: Deserialize<'de>, Self: Sized,

fn redacts_id(&self, room_rules: &RoomVersionRules) -> Option<OwnedEventId>

where Self: Sized,

fn is_redacted(&self) -> bool

where Self: Sized,

fn into_canonical_object(self) -> CanonicalJsonObject

where Self: Sized,

fn to_canonical_object(&self) -> CanonicalJsonObject

fn into_value(self) -> JsonValue

where Self: Sized,

fn to_value(&self) -> JsonValue

fn as_mut_pdu(&mut self) -> &mut Pdu

fn event_type(&self) -> &TimelineEventType

impl Event for Pdu

where Self: Send + Sync + 'static,

fn auth_events( &self, ) -> impl DoubleEndedIterator<Item = &EventId> + Clone + Send + '_

All the authenticating events for this event.

fn auth_events_into( self, ) -> impl IntoIterator<IntoIter = impl Iterator<Item = OwnedEventId>> + Send

All the authenticating events for this event.

fn content(&self) -> &RawJsonValue

The event’s content.

fn event_id(&self) -> &EventId

The EventId of this event.

fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch

The time of creation on the originating server.

fn prev_events( &self, ) -> impl DoubleEndedIterator<Item = &EventId> + Clone + Send + '_

The events before this event.

fn redacts(&self) -> Option<&EventId>

If this event is a redaction event this is the event it redacts.

fn rejected(&self) -> bool

see: https://spec.matrix.org/v1.14/rooms/v11/#rejected-events

fn room_id(&self) -> &RoomId

The RoomId of this event.

fn sender(&self) -> &UserId

The UserId of this event.

fn state_key(&self) -> Option<&str>

The state key for this event.

fn kind(&self) -> &TimelineEventType

The event type.

fn unsigned(&self) -> Option<&RawJsonValue>

Metadata container; peer-trusted only.

fn as_mut_pdu(&mut self) -> &mut Pdu

fn as_pdu(&self) -> &Pdu

fn into_pdu(self) -> Pdu

fn is_owned(&self) -> bool

fn is_type_and_state_key( &self, kind: &TimelineEventType, state_key: &str, ) -> bool

fn into_format<T>(self) -> T

where T: From<Owned<Self>>, Self: Sized,

Serialize into a Ruma JSON format, consuming.

fn to_format<'a, T>(&'a self) -> T

where T: From<Ref<'a, Self>>, Self: Sized + 'a,

Serialize into a Ruma JSON format

fn contains_unsigned_property<T>(&self, property: &str, is_type: T) -> bool

where T: FnOnce(&JsonValue) -> bool, Self: Sized,

fn get_unsigned_property<T>(&self, property: &str) -> Result<T>

where T: for<'de> Deserialize<'de>, Self: Sized,

fn get_unsigned_as_value(&self) -> JsonValue

where Self: Sized,

fn get_unsigned<T>(&self) -> Result<T>

where T: for<'de> Deserialize<'de>, Self: Sized,

fn get_content_as_value(&self) -> JsonValue

where Self: Sized,

fn get_content<T>(&self) -> Result<T>

where for<'de> T: Deserialize<'de>, Self: Sized,

fn redacts_id(&self, room_rules: &RoomVersionRules) -> Option<OwnedEventId>

where Self: Sized,

fn is_redacted(&self) -> bool

where Self: Sized,

fn into_canonical_object(self) -> CanonicalJsonObject

where Self: Sized,

fn to_canonical_object(&self) -> CanonicalJsonObject

fn into_value(self) -> JsonValue

where Self: Sized,

fn to_value(&self) -> JsonValue

fn event_type(&self) -> &TimelineEventType

impl Ord for Pdu

Ordering determined by the Pdu’s ID, not the memory representations.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Pdu

Equality determined by the Pdu’s ID, not the memory representations.

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Pdu

Ordering determined by the Pdu’s ID, not the memory representations.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Pdu

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Pdu

Prevent derived equality which wouldn’t limit itself to event_id