50 lines
1.6 KiB
Rust
50 lines
1.6 KiB
Rust
//! Types for the [`m.room.pinned_events`] event.
|
|
//!
|
|
//! [`m.room.pinned_events`]: https://spec.matrix.org/latest/client-server-api/#mroompinned_events
|
|
|
|
use ruma_common::OwnedEventId;
|
|
use ruma_macros::EventContent;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use crate::EmptyStateKey;
|
|
|
|
/// The content of an `m.room.pinned_events` event.
|
|
///
|
|
/// Used to "pin" particular events in a room for other participants to review later.
|
|
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
|
|
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
|
|
#[ruma_event(type = "m.room.pinned_events", kind = State, state_key_type = EmptyStateKey)]
|
|
pub struct RoomPinnedEventsEventContent {
|
|
/// An ordered list of event IDs to pin.
|
|
pub pinned: Vec<OwnedEventId>,
|
|
}
|
|
|
|
impl RoomPinnedEventsEventContent {
|
|
/// Creates a new `RoomPinnedEventsEventContent` with the given events.
|
|
pub fn new(pinned: Vec<OwnedEventId>) -> Self {
|
|
Self { pinned }
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use ruma_common::owned_event_id;
|
|
|
|
use super::RoomPinnedEventsEventContent;
|
|
|
|
#[test]
|
|
fn serialization_deserialization() {
|
|
let mut content: RoomPinnedEventsEventContent =
|
|
RoomPinnedEventsEventContent { pinned: Vec::new() };
|
|
|
|
content.pinned.push(owned_event_id!("$a:example.com"));
|
|
content.pinned.push(owned_event_id!("$b:example.com"));
|
|
|
|
let serialized = serde_json::to_string(&content).unwrap();
|
|
let parsed_content: RoomPinnedEventsEventContent =
|
|
serde_json::from_str(&serialized).unwrap();
|
|
|
|
assert_eq!(parsed_content.pinned, content.pinned);
|
|
}
|
|
}
|