mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-07 07:27:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

chore(ui): Move EventMeta inside the metadata module.

Browse Source 
This patch moves the `EventMeta` type from `state.rs` to `metadata.rs`.
This commit is contained in:
Ivan Enderlin
2025-01-28 15:33:29 +01:00
parent 66e3ddec47
commit d755a8a3aa
3 changed files with 75 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
crates/matrix-sdk-ui/src/timeline/controller/metadata.rs
View File

@@ -286,3 +286,76 @@ pub(in crate::timeline) enum RelativePosition {
/// Event B is before (older than) event A.
Before,
}
/// Metadata about an event that needs to be kept in memory.
#[derive(Debug, Clone)]
pub(in crate::timeline) struct EventMeta {
/// The ID of the event.
pub event_id: OwnedEventId,
/// Whether the event is among the timeline items.
pub visible: bool,
/// Foundation for the mapping between remote events to timeline items.
///
/// Let's explain it. The events represent the first set and are stored in
/// [`ObservableItems::all_remote_events`], and the timeline
/// items represent the second set and are stored in
/// [`ObservableItems::items`].
///
/// Each event is mapped to at most one timeline item:
///
/// - `None` if the event isn't rendered in the timeline (e.g. some state
/// events, or malformed events) or is rendered as a timeline item that
/// attaches to or groups with another item, like reactions,
/// - `Some(_)` if the event is rendered in the timeline.
///
/// This is neither a surjection nor an injection. Every timeline item may
/// not be attached to an event, for example with a virtual timeline item.
/// We can formulate other rules:
///
/// - a timeline item that doesn't _move_ and that is represented by an
/// event has a mapping to an event,
/// - a virtual timeline item has no mapping to an event.
///
/// Imagine the following remote events:
///
/// | index | remote events |
/// +-------+---------------+
/// | 0 | `$ev0` |
/// | 1 | `$ev1` |
/// | 2 | `$ev2` |
/// | 3 | `$ev3` |
/// | 4 | `$ev4` |
/// | 5 | `$ev5` |
///
/// Once rendered in a timeline, it for example produces:
///
/// | index | item | related items |
/// +-------+-------------------+----------------------+
/// | 0 | content of `$ev0` | |
/// | 1 | content of `$ev2` | reaction with `$ev4` |
/// | 2 | day divider | |
/// | 3 | content of `$ev3` | |
/// | 4 | content of `$ev5` | |
///
/// Note the day divider that is a virtual item. Also note `$ev4` which is
/// a reaction to `$ev2`. Finally note that `$ev1` is not rendered in
/// the timeline.
///
/// The mapping between remote event index to timeline item index will look
/// like this:
///
/// | remote event index | timeline item index | comment |
/// +--------------------+---------------------+--------------------------------------------+
/// | 0 | `Some(0)` | `$ev0` is rendered as the #0 timeline item |
/// | 1 | `None` | `$ev1` isn't rendered in the timeline |
/// | 2 | `Some(1)` | `$ev2` is rendered as the #1 timeline item |
/// | 3 | `Some(3)` | `$ev3` is rendered as the #3 timeline item |
/// | 4 | `None` | `$ev4` is a reaction to item #1 |
/// | 5 | `Some(4)` | `$ev5` is rendered as the #4 timeline item |
///
/// Note that the #2 timeline item (the day divider) doesn't map to any
/// remote event, but if it moves, it has an impact on this mapping.
pub timeline_item_index: Option<usize>,
}

2
crates/matrix-sdk-ui/src/timeline/controller/observable_items.rs
View File

@@ -26,7 +26,7 @@ use eyeball_im::{
use imbl::Vector;
use ruma::EventId;
use super::{state::EventMeta, TimelineItem};
use super::{metadata::EventMeta, TimelineItem};
/// An `ObservableItems` is a type similar to
/// [`ObservableVector<Arc<TimelineItem>>`] except the API is limited and,

74
crates/matrix-sdk-ui/src/timeline/controller/state.rs
View File

@@ -45,6 +45,7 @@ use super::{
traits::RoomDataProvider,
Profile, TimelineItem,
},
metadata::EventMeta,
observable_items::ObservableItems,
DateDividerMode, TimelineFocusKind, TimelineMetadata, TimelineSettings,
TimelineStateTransaction,
@@ -406,76 +407,3 @@ impl FullEventMeta<'_> {
}
}
}
/// Metadata about an event that needs to be kept in memory.
#[derive(Debug, Clone)]
pub(crate) struct EventMeta {
/// The ID of the event.
pub event_id: OwnedEventId,
/// Whether the event is among the timeline items.
pub visible: bool,
/// Foundation for the mapping between remote events to timeline items.
///
/// Let's explain it. The events represent the first set and are stored in
/// [`ObservableItems::all_remote_events`], and the timeline
/// items represent the second set and are stored in
/// [`ObservableItems::items`].
///
/// Each event is mapped to at most one timeline item:
///
/// - `None` if the event isn't rendered in the timeline (e.g. some state
/// events, or malformed events) or is rendered as a timeline item that
/// attaches to or groups with another item, like reactions,
/// - `Some(_)` if the event is rendered in the timeline.
///
/// This is neither a surjection nor an injection. Every timeline item may
/// not be attached to an event, for example with a virtual timeline item.
/// We can formulate other rules:
///
/// - a timeline item that doesn't _move_ and that is represented by an
/// event has a mapping to an event,
/// - a virtual timeline item has no mapping to an event.
///
/// Imagine the following remote events:
///
/// | index | remote events |
/// +-------+---------------+
/// | 0 | `$ev0` |
/// | 1 | `$ev1` |
/// | 2 | `$ev2` |
/// | 3 | `$ev3` |
/// | 4 | `$ev4` |
/// | 5 | `$ev5` |
///
/// Once rendered in a timeline, it for example produces:
///
/// | index | item | related items |
/// +-------+-------------------+----------------------+
/// | 0 | content of `$ev0` | |
/// | 1 | content of `$ev2` | reaction with `$ev4` |
/// | 2 | day divider | |
/// | 3 | content of `$ev3` | |
/// | 4 | content of `$ev5` | |
///
/// Note the day divider that is a virtual item. Also note `$ev4` which is
/// a reaction to `$ev2`. Finally note that `$ev1` is not rendered in
/// the timeline.
///
/// The mapping between remote event index to timeline item index will look
/// like this:
///
/// | remote event index | timeline item index | comment |
/// +--------------------+---------------------+--------------------------------------------+
/// | 0 | `Some(0)` | `$ev0` is rendered as the #0 timeline item |
/// | 1 | `None` | `$ev1` isn't rendered in the timeline |
/// | 2 | `Some(1)` | `$ev2` is rendered as the #1 timeline item |
/// | 3 | `Some(3)` | `$ev3` is rendered as the #3 timeline item |
/// | 4 | `None` | `$ev4` is a reaction to item #1 |
/// | 5 | `Some(4)` | `$ev5` is rendered as the #4 timeline item |
///
/// Note that the #2 timeline item (the day divider) doesn't map to any
/// remote event, but if it moves, it has an impact on this mapping.
pub timeline_item_index: Option<usize>,
}