ruwuma/crates/ruma-state-res/src/state_event.rs

137 lines
3.3 KiB
Rust

use std::{
borrow::Borrow,
fmt::{Debug, Display},
hash::Hash,
sync::Arc,
};
use ruma_common::MilliSecondsSinceUnixEpoch;
use ruma_events::EventType;
use ruma_identifiers::{EventId, RoomId, UserId};
use serde_json::value::RawValue as RawJsonValue;
/// Abstraction of a PDU so users can have their own PDU types.
pub trait Event {
type Id: Clone + Debug + Display + Eq + Ord + Hash + Borrow<EventId>;
/// The `EventId` of this event.
fn event_id(&self) -> &Self::Id;
/// The `RoomId` of this event.
fn room_id(&self) -> &RoomId;
/// The `UserId` of this event.
fn sender(&self) -> &UserId;
/// The time of creation on the originating server.
fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch;
/// The event type.
fn event_type(&self) -> &EventType;
/// The event's content.
fn content(&self) -> &RawJsonValue;
/// The state key for this event.
fn state_key(&self) -> Option<&str>;
/// The events before this event.
// Requires GATs to avoid boxing (and TAIT for making it convenient).
fn prev_events(&self) -> Box<dyn DoubleEndedIterator<Item = &Self::Id> + '_>;
/// All the authenticating events for this event.
// Requires GATs to avoid boxing (and TAIT for making it convenient).
fn auth_events(&self) -> Box<dyn DoubleEndedIterator<Item = &Self::Id> + '_>;
/// If this event is a redaction event this is the event it redacts.
fn redacts(&self) -> Option<&Self::Id>;
}
impl<T: Event> Event for &T {
type Id = T::Id;
fn event_id(&self) -> &Self::Id {
(*self).event_id()
}
fn room_id(&self) -> &RoomId {
(*self).room_id()
}
fn sender(&self) -> &UserId {
(*self).sender()
}
fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch {
(*self).origin_server_ts()
}
fn event_type(&self) -> &EventType {
(*self).event_type()
}
fn content(&self) -> &RawJsonValue {
(*self).content()
}
fn state_key(&self) -> Option<&str> {
(*self).state_key()
}
fn prev_events(&self) -> Box<dyn DoubleEndedIterator<Item = &Self::Id> + '_> {
(*self).prev_events()
}
fn auth_events(&self) -> Box<dyn DoubleEndedIterator<Item = &Self::Id> + '_> {
(*self).auth_events()
}
fn redacts(&self) -> Option<&Self::Id> {
(*self).redacts()
}
}
impl<T: Event> Event for Arc<T> {
type Id = T::Id;
fn event_id(&self) -> &Self::Id {
(&**self).event_id()
}
fn room_id(&self) -> &RoomId {
(&**self).room_id()
}
fn sender(&self) -> &UserId {
(&**self).sender()
}
fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch {
(&**self).origin_server_ts()
}
fn event_type(&self) -> &EventType {
(&**self).event_type()
}
fn content(&self) -> &RawJsonValue {
(&**self).content()
}
fn state_key(&self) -> Option<&str> {
(&**self).state_key()
}
fn prev_events(&self) -> Box<dyn DoubleEndedIterator<Item = &Self::Id> + '_> {
(&**self).prev_events()
}
fn auth_events(&self) -> Box<dyn DoubleEndedIterator<Item = &Self::Id> + '_> {
(&**self).auth_events()
}
fn redacts(&self) -> Option<&Self::Id> {
(&**self).redacts()
}
}