diff --git a/crates/ruma-events/src/content.rs b/crates/ruma-events/src/content.rs index 58ff1ef1..929fb546 100644 --- a/crates/ruma-events/src/content.rs +++ b/crates/ruma-events/src/content.rs @@ -22,6 +22,7 @@ pub trait EventContent: Sized + Serialize { fn event_type(&self) -> Self::EventType; } +/// Extension trait for [`Raw`]. pub trait RawExt { /// Try to deserialize the JSON as an event's content with the given event type. fn deserialize_with_type(&self, event_type: T::EventType) -> serde_json::Result; diff --git a/crates/ruma-events/src/lib.rs b/crates/ruma-events/src/lib.rs index c920b56d..15affb89 100644 --- a/crates/ruma-events/src/lib.rs +++ b/crates/ruma-events/src/lib.rs @@ -100,6 +100,8 @@ //! )); //! ``` +#![warn(missing_docs)] + use std::{collections::BTreeSet, fmt}; use ruma_common::{EventEncryptionAlgorithm, OwnedUserId, RoomVersionId}; diff --git a/crates/ruma-events/src/room/message.rs b/crates/ruma-events/src/room/message.rs index 24f8f204..56f93240 100644 --- a/crates/ruma-events/src/room/message.rs +++ b/crates/ruma-events/src/room/message.rs @@ -945,6 +945,9 @@ impl TryFrom> for RelationWithoutReplacement { } } +/// Metadata about an event to be replaced. +/// +/// To be used with [`RoomMessageEventContent::make_replacement`]. #[derive(Debug)] pub struct ReplacementMetadata { event_id: OwnedEventId, @@ -952,6 +955,7 @@ pub struct ReplacementMetadata { } impl ReplacementMetadata { + /// Creates a new `ReplacementMetadata` with the given event ID and mentions. pub fn new(event_id: OwnedEventId, mentions: Option) -> Self { Self { event_id, mentions } }