157 lines
5.2 KiB
Rust
157 lines
5.2 KiB
Rust
//! Types for persistent data unit schemas
|
|
//!
|
|
//! The differences between the `RoomV1Pdu` schema and the `RoomV3Pdu` schema are
|
|
//! that the `RoomV1Pdu` takes an `event_id` field (`RoomV3Pdu` does not), and
|
|
//! `auth_events` and `prev_events` take `Vec<(EventId, EventHash)> rather than
|
|
//! `Vec<EventId>` in `RoomV3Pdu`.
|
|
//!
|
|
//! The stubbed versions of each PDU type remove the `event_id` field (if any)
|
|
//! and the `room_id` field for use in PDU templates.
|
|
|
|
use std::collections::BTreeMap;
|
|
|
|
use js_int::UInt;
|
|
use ruma_common::MilliSecondsSinceUnixEpoch;
|
|
use ruma_identifiers::{EventId, RoomId, ServerNameBox, ServerSigningKeyId, UserId};
|
|
use serde::{Deserialize, Serialize};
|
|
use serde_json::Value as JsonValue;
|
|
|
|
use crate::EventType;
|
|
|
|
/// Enum for PDU schemas
|
|
#[derive(Clone, Debug, Deserialize, Serialize)]
|
|
#[serde(untagged)]
|
|
pub enum Pdu {
|
|
/// PDU for room versions 1 and 2.
|
|
RoomV1Pdu(RoomV1Pdu),
|
|
|
|
/// PDU for room versions 3 and above.
|
|
RoomV3Pdu(RoomV3Pdu),
|
|
}
|
|
|
|
/// A 'persistent data unit' (event) for room versions 1 and 2.
|
|
#[derive(Clone, Debug, Deserialize, Serialize)]
|
|
pub struct RoomV1Pdu {
|
|
/// Event ID for the PDU.
|
|
pub event_id: EventId,
|
|
|
|
/// The room this event belongs to.
|
|
pub room_id: RoomId,
|
|
|
|
/// The user id of the user who sent this event.
|
|
pub sender: UserId,
|
|
|
|
#[cfg(not(feature = "unstable-pre-spec"))]
|
|
#[cfg_attr(docsrs, doc(cfg(not(feature = "unstable-pre-spec"))))]
|
|
/// The `server_name` of the homeserver that created this event.
|
|
pub origin: String,
|
|
|
|
/// Timestamp (milliseconds since the UNIX epoch) on originating homeserver
|
|
/// of when this event was created.
|
|
pub origin_server_ts: MilliSecondsSinceUnixEpoch,
|
|
|
|
// TODO: Encode event type as content enum variant, like event enums do
|
|
/// The event's type.
|
|
#[serde(rename = "type")]
|
|
pub kind: EventType,
|
|
|
|
/// The event's content.
|
|
pub content: JsonValue,
|
|
|
|
/// A key that determines which piece of room state the event represents.
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub state_key: Option<String>,
|
|
|
|
/// Event IDs for the most recent events in the room that the homeserver was
|
|
/// aware of when it created this event.
|
|
#[serde(skip_serializing_if = "Vec::is_empty")]
|
|
pub prev_events: Vec<(EventId, EventHash)>,
|
|
|
|
/// The maximum depth of the `prev_events`, plus one.
|
|
pub depth: UInt,
|
|
|
|
/// Event IDs for the authorization events that would allow this event to be
|
|
/// in the room.
|
|
#[serde(skip_serializing_if = "Vec::is_empty")]
|
|
pub auth_events: Vec<(EventId, EventHash)>,
|
|
|
|
/// For redaction events, the ID of the event being redacted.
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub redacts: Option<EventId>,
|
|
|
|
/// Additional data added by the origin server but not covered by the
|
|
/// signatures.
|
|
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
|
|
pub unsigned: BTreeMap<String, JsonValue>,
|
|
|
|
/// Content hashes of the PDU.
|
|
pub hashes: EventHash,
|
|
|
|
/// Signatures for the PDU.
|
|
pub signatures: BTreeMap<ServerNameBox, BTreeMap<ServerSigningKeyId, String>>,
|
|
}
|
|
|
|
/// A 'persistent data unit' (event) for room versions 3 and beyond.
|
|
#[derive(Clone, Debug, Deserialize, Serialize)]
|
|
pub struct RoomV3Pdu {
|
|
/// The room this event belongs to.
|
|
pub room_id: RoomId,
|
|
|
|
/// The user id of the user who sent this event.
|
|
pub sender: UserId,
|
|
|
|
#[cfg(not(feature = "unstable-pre-spec"))]
|
|
#[cfg_attr(docsrs, doc(cfg(not(feature = "unstable-pre-spec"))))]
|
|
/// The `server_name` of the homeserver that created this event.
|
|
pub origin: String,
|
|
|
|
/// Timestamp (milliseconds since the UNIX epoch) on originating homeserver
|
|
/// of when this event was created.
|
|
pub origin_server_ts: MilliSecondsSinceUnixEpoch,
|
|
|
|
// TODO: Encode event type as content enum variant, like event enums do
|
|
/// The event's type.
|
|
#[serde(rename = "type")]
|
|
pub kind: EventType,
|
|
|
|
/// The event's content.
|
|
pub content: JsonValue,
|
|
|
|
/// A key that determines which piece of room state the event represents.
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub state_key: Option<String>,
|
|
|
|
/// Event IDs for the most recent events in the room that the homeserver was
|
|
/// aware of when it created this event.
|
|
pub prev_events: Vec<EventId>,
|
|
|
|
/// The maximum depth of the `prev_events`, plus one.
|
|
pub depth: UInt,
|
|
|
|
/// Event IDs for the authorization events that would allow this event to be
|
|
/// in the room.
|
|
pub auth_events: Vec<EventId>,
|
|
|
|
/// For redaction events, the ID of the event being redacted.
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub redacts: Option<EventId>,
|
|
|
|
/// Additional data added by the origin server but not covered by the
|
|
/// signatures.
|
|
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
|
|
pub unsigned: BTreeMap<String, JsonValue>,
|
|
|
|
/// Content hashes of the PDU.
|
|
pub hashes: EventHash,
|
|
|
|
/// Signatures for the PDU.
|
|
pub signatures: BTreeMap<ServerNameBox, BTreeMap<ServerSigningKeyId, String>>,
|
|
}
|
|
|
|
/// Content hashes of a PDU.
|
|
#[derive(Clone, Debug, Deserialize, Serialize)]
|
|
pub struct EventHash {
|
|
/// The SHA-256 hash.
|
|
pub sha256: String,
|
|
}
|