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<Unsigned>,
}

Stores a Matrix persistent data unit in typed form.

The representation retains canonical event fields used by state resolution, storage, and client serialization. Federation adapters normalize version-specific wire shapes.

Fields

kind: TimelineEventType

Matrix event type.

The value is serialized under the top-level type field.

content: Content

Raw canonical event content.

Content remains encoded until a caller requests a typed or JSON value.

event_id: OwnedEventId

Matrix identifier assigned to this event.

Stored PDUs always carry an owned event ID, including room versions that derive it outside the federation wire object.

room_id: OwnedRoomId

Matrix room containing this event.

Stored PDUs carry the room ID even when a room version omits it from a creation event’s federation representation.

sender: OwnedUserId

Matrix user who sent the event.

The sender participates in authorization and client-visible event output.

state_key: Option<StateKey>

State key when this is a state event.

Message-like events store None and omit the field during serialization.

redacts: Option<OwnedEventId>

Event targeted by a redaction when carried at the top level.

Newer room versions can place this value in event content instead. An absent target is omitted during serialization.

prev_events: PrevEvents

Events declared as direct predecessors of this event.

The sequence is stored inline for the common single-predecessor case.

auth_events: AuthEvents

Events used to authorize this event.

These identifiers form the event’s explicit authorization dependency set.

origin_server_ts: UInt

Millisecond timestamp supplied by the originating server.

The value is preserved for ordering metadata and client serialization.

depth: UInt

Event depth in the room directed acyclic graph.

Depth is originating-server-provided graph metadata and is distinct from the local timeline sequence.

hashes: EventHash

Content hash declared by the event.

Federation validation compares the declaration with the computed content hash to detect content changes.

origin: Option<OwnedServerName>

Server that originated an event carrying a top-level origin field.

Legacy event formats retain this value for local and remote events. The field is absent when it was not carried by the event format.

unsigned: Option<Unsigned>

Unsigned metadata excluded from event hashing and signing.

Stored values are local annotations such as transaction IDs, age, prior state, and bundled relations. The field is omitted when absent.

Implementations

impl Pdu

pub fn remove_transaction_id(&mut self) -> Result

Removes the local transaction ID from unsigned event metadata.

Other unsigned properties are retained and the object is re-encoded. An event without unsigned data is left unchanged.

impl Pdu

pub fn remove_prev_state(&mut self) -> Result

State-section serving strips the stored prev_content/prev_sender pair, dropping unsigned entirely when emptied; timeline serving keeps the trio.

impl Pdu

pub fn add_age(&mut self) -> Result

Adds the event’s current age to unsigned metadata.

Age is the saturating millisecond difference between the current time and origin_server_ts. Future timestamps can therefore produce a negative value.

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

Adds or replaces a named bundled relation in unsigned metadata.

The related PDU is serialized under unsigned.m.relations; None stores an empty object for the named relation. Existing unsigned properties are retained.

impl Pdu

pub fn set_thread_participated(&mut self, participated: bool) -> Result

MSC3816: overwrite unsigned.m.relations.m.thread.current_user_participated with a per-requester value. No-op when the event carries no thread bundle.

impl Pdu

pub fn thread_latest_event(&self) -> Option<(OwnedEventId, OwnedUserId)>

MSC4025: identify the bundled m.thread latest_event without parsing the whole bundle: the sender keys the erasure gate, the event_id loads the event on a hit.

impl Pdu

pub fn set_thread_latest_event( &mut self, latest: &Raw<AnySyncMessageLikeEvent>, ) -> Result

MSC4025: overwrite unsigned.m.relations.m.thread.latest_event, serving the pruned form of an erased sender’s thread activity. No-op when the event carries no thread bundle.

impl Pdu

pub fn set_thread_count(&mut self, count: usize) -> Result

MSC3856: overwrite unsigned.m.relations.m.thread.count with a per-requester value excluding ignored senders’ replies. No-op when the event carries no thread bundle.

impl Pdu

pub fn set_replacement_bundle( &mut self, replacement: &Raw<AnySyncMessageLikeEvent>, ) -> Result

MSC3925: fold the newest m.replace edit into unsigned.m.relations.m.replace as the full replacement event, preserving an existing bundle such as m.thread and creating unsigned when absent.

impl Pdu

pub fn remove_replacement_bundle(&mut self) -> Result

Inverse of set_replacement_bundle: excise m.replace from unsigned.m.relations, dropping m.relations when the excision empties it and unsigned when that leaves nothing.

impl Pdu

pub fn set_reference_bundle(&mut self, event_ids: &[OwnedEventId]) -> Result

MSC2675/MSC3267: fold reference relations into unsigned.m.relations.m.reference as { chunk: [{ event_id }, ...] }, preserving an existing bundle such as m.thread or m.replace and creating unsigned when absent.

impl Pdu

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

Inserts room and event IDs before deserializing a canonical PDU object.

Existing values under those keys are replaced. The resulting typed PDU owns both supplied identifiers.

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

Inserts an event ID before deserializing a canonical PDU object.

Any existing event_id value is replaced. Other object fields pass through to normal PDU deserialization.

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

Normalizes federation wire fields and validates PDU format and room ID.

Version-specific wire fields are converted to the stored representation before these checks. Signature, content-hash, and authorization validation remain the caller’s responsibility.

Panics

Panics if the object lacks type while the selected rules do not require a create-event room ID.

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

Validates a canonical PDU object before deserializing it.

Checks use the supplied room-version event-format rules. Successful validation returns the typed stored representation.

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

Deserializes a canonical JSON object into a stored PDU.

The object is wrapped as a canonical JSON value before typed deserialization. No room-version format checks are performed.

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

Deserializes raw JSON through a canonical JSON value.

Canonical conversion normalizes integer and object representation before the PDU fields are decoded. No room-version format checks are performed.

Panics

Panics if the raw JSON contains a value outside canonical JSON, such as a floating-point value or an integer outside the canonical range.

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

Deserializes a canonical JSON value into a stored PDU.

The input must contain the fields required by Pdu. No room-version format checks are performed before deserialization.

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

Deserializes raw JSON directly into a stored PDU.

This path uses Pdu’s Serde representation without first canonicalizing the input. Callers that require canonical validation should use a checked constructor.

pub fn redacted(&self, rules: &RedactionRules) -> Result<Self>

MSC4025: a pruned clone per the redaction rules, carrying no redacted_because; no redaction event exists for a serve-time erasure.

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 Eq for Pdu

Prevent derived equality which wouldn’t limit itself to event_id

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

Returns mutable access to the common PDU representation.

fn as_pdu(&self) -> &Pdu

Borrows the event as the common PDU representation.

fn into_pdu(self) -> Pdu

Converts the event into an owned common PDU representation.

fn is_owned(&self) -> bool

Reports whether consuming conversion can move an owned PDU.

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

Checks whether this event has both the requested type and state key.

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,

Checks an unsigned-data property with a caller-supplied predicate.

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

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

Deserializes one property from the event’s unsigned data.

fn get_unsigned_as_value(&self) -> JsonValue

where Self: Sized,

Deserializes the event’s unsigned data as a JSON value.

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

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

Deserializes the complete unsigned-data object into a requested type.

fn get_content_as_value(&self) -> JsonValue

where Self: Sized,

Deserializes event content as an untyped JSON value.

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

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

Deserializes event content into a requested type.

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

where Self: Sized,

Resolves the event ID targeted by a redaction event.

fn is_redacted(&self) -> bool

where Self: Sized,

Reports whether the event carries redaction metadata.

fn into_canonical_object(self) -> CanonicalJsonObject

where Self: Sized,

Consumes the event and serializes its PDU as a canonical JSON object.

fn to_canonical_object(&self) -> CanonicalJsonObject

Serializes the event’s PDU as an owned canonical JSON object.

fn into_value(self) -> JsonValue

where Self: Sized,

Consumes the event and serializes its PDU as a JSON value.

fn to_value(&self) -> JsonValue

Serializes the event’s PDU as an owned JSON value.

fn event_type(&self) -> &TimelineEventType

Returns the event’s timeline type.

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

Borrows the event as the common PDU representation.

fn into_pdu(self) -> Pdu

Converts the event into an owned common PDU representation.

fn is_owned(&self) -> bool

Reports whether consuming conversion can move an owned PDU.

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

Checks whether this event has both the requested type and state key.

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,

Checks an unsigned-data property with a caller-supplied predicate.

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

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

Deserializes one property from the event’s unsigned data.

fn get_unsigned_as_value(&self) -> JsonValue

where Self: Sized,

Deserializes the event’s unsigned data as a JSON value.

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

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

Deserializes the complete unsigned-data object into a requested type.

fn get_content_as_value(&self) -> JsonValue

where Self: Sized,

Deserializes event content as an untyped JSON value.

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

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

Deserializes event content into a requested type.

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

where Self: Sized,

Resolves the event ID targeted by a redaction event.

fn is_redacted(&self) -> bool

where Self: Sized,

Reports whether the event carries redaction metadata.

fn into_canonical_object(self) -> CanonicalJsonObject

where Self: Sized,

Consumes the event and serializes its PDU as a canonical JSON object.

fn to_canonical_object(&self) -> CanonicalJsonObject

Serializes the event’s PDU as an owned canonical JSON object.

fn into_value(self) -> JsonValue

where Self: Sized,

Consumes the event and serializes its PDU as a JSON value.

fn to_value(&self) -> JsonValue

Serializes the event’s PDU as an owned JSON value.

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

Returns mutable access to the common PDU representation.

fn event_type(&self) -> &TimelineEventType

Returns the event’s timeline type.

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

Equality operator ==.

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

Inequality operator !=.

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.