matrix_sdk_test/sync_builder/
left_room.rs

1use ruma::{
2    api::client::sync::sync_events::v3::LeftRoom,
3    events::{AnyRoomAccountDataEvent, AnySyncStateEvent, AnySyncTimelineEvent},
4    serde::Raw,
5    OwnedRoomId, RoomId,
6};
7
8use super::{RoomAccountDataTestEvent, StateTestEvent};
9use crate::DEFAULT_TEST_ROOM_ID;
10
11pub struct LeftRoomBuilder {
12    pub(super) room_id: OwnedRoomId,
13    pub(super) inner: LeftRoom,
14}
15
16impl LeftRoomBuilder {
17    /// Create a new `LeftRoomBuilder` for the given room ID.
18    ///
19    /// If the room ID is [`DEFAULT_TEST_ROOM_ID`],
20    /// [`LeftRoomBuilder::default()`] can be used instead.
21    pub fn new(room_id: &RoomId) -> Self {
22        Self { room_id: room_id.to_owned(), inner: Default::default() }
23    }
24
25    /// Get the room ID of this [`LeftRoomBuilder`].
26    pub fn room_id(&self) -> &RoomId {
27        &self.room_id
28    }
29
30    /// Add an event to the timeline.
31    ///
32    /// The raw event can be created with the
33    /// [`sync_timeline_event`](crate::sync_timeline_event) macro.
34    pub fn add_timeline_event(mut self, event: impl Into<Raw<AnySyncTimelineEvent>>) -> Self {
35        self.inner.timeline.events.push(event.into());
36        self
37    }
38
39    /// Add events in bulk to the timeline.
40    pub fn add_timeline_bulk<I>(mut self, events: I) -> Self
41    where
42        I: IntoIterator<Item = Raw<AnySyncTimelineEvent>>,
43    {
44        self.inner.timeline.events.extend(events);
45        self
46    }
47
48    /// Add state events in bulk to the timeline.
49    ///
50    /// This is a convenience method that casts `Raw<AnySyncStateEvent>` to
51    /// `Raw<AnySyncTimelineEvent>` and calls `LeftRoom::add_timeline_bulk()`.
52    pub fn add_timeline_state_bulk<I>(self, events: I) -> Self
53    where
54        I: IntoIterator<Item = Raw<AnySyncStateEvent>>,
55    {
56        let events = events.into_iter().map(|event| event.cast());
57        self.add_timeline_bulk(events)
58    }
59
60    /// Set the timeline as limited.
61    pub fn set_timeline_limited(mut self) -> Self {
62        self.inner.timeline.limited = true;
63        self
64    }
65
66    /// Set the `prev_batch` of the timeline.
67    pub fn set_timeline_prev_batch(mut self, prev_batch: String) -> Self {
68        self.inner.timeline.prev_batch = Some(prev_batch);
69        self
70    }
71
72    /// Add an event to the state.
73    pub fn add_state_event(mut self, event: StateTestEvent) -> Self {
74        self.inner.state.events.push(event.into_raw_event());
75        self
76    }
77
78    /// Add events in bulk to the state.
79    pub fn add_state_bulk<I>(mut self, events: I) -> Self
80    where
81        I: IntoIterator<Item = Raw<AnySyncStateEvent>>,
82    {
83        self.inner.state.events.extend(events);
84        self
85    }
86
87    /// Add room account data.
88    pub fn add_account_data(mut self, event: RoomAccountDataTestEvent) -> Self {
89        self.inner.account_data.events.push(event.into_raw_event());
90        self
91    }
92
93    /// Add room account data in bulk.
94    pub fn add_account_data_bulk<I>(mut self, events: I) -> Self
95    where
96        I: IntoIterator<Item = Raw<AnyRoomAccountDataEvent>>,
97    {
98        self.inner.account_data.events.extend(events);
99        self
100    }
101}
102
103impl Default for LeftRoomBuilder {
104    fn default() -> Self {
105        Self::new(&DEFAULT_TEST_ROOM_ID)
106    }
107}
matrix_sdk_test/sync_builder/left_room.rs

matrix_sdk_test/sync_builder/
left_room.rs
