Struct TimelineBuilder

pub struct TimelineBuilder { /* private fields */ }

Builder that allows creating and configuring various parts of a Timeline.

Implementations

impl TimelineBuilder

pub fn with_focus(self, focus: TimelineFocus) -> Self

Sets up the initial focus for this timeline.

This can be changed later on while the timeline is alive.

pub fn with_unable_to_decrypt_hook(self, hook: Arc<UtdHookManager>) -> Self

Sets up a hook to catch unable-to-decrypt (UTD) events for the timeline we’re building.

If it was previously set before, will overwrite the previous one.

pub fn with_internal_id_prefix(self, prefix: String) -> Self

Sets the internal id prefix for this timeline.

The prefix will be prepended to any internal ID using when generating timeline IDs for this timeline.

pub fn with_date_divider_mode(self, mode: DateDividerMode) -> Self

Chose when to insert the date separators, either in between each day or each month.

pub fn track_read_marker_and_receipts(self) -> Self

Enable tracking of the fully-read marker and the read receipts on the timeline.

pub fn event_filter<F>(self, filter: F) -> Self

where F: Fn(&AnySyncTimelineEvent, &RoomVersionId) -> bool + Send + Sync + 'static,

Use the given filter to choose whether to add events to the timeline.

Arguments

• filter - A function that takes a deserialized event, and should return true if the event should be added to the Timeline.

If this is not overridden, the timeline uses the default filter that only allows events that are materialized into a Timeline item. For instance, reactions and edits don’t get their own timeline item (as they affect another existing one), so they’re “filtered out” to reflect that.

You can use the default event filter with crate::timeline::default_event_filter so as to chain it with your own event filter, if you want to avoid situations where a read receipt would be attached to an event that doesn’t get its own timeline item.

Note that currently:

• Not all event types have a representation as a TimelineItem so these are not added no matter what the filter returns.
• It is not possible to filter out m.room.encrypted events (otherwise they couldn’t be decrypted when the appropriate room key arrives).

pub fn add_failed_to_parse(self, add: bool) -> Self

Whether to add events that failed to deserialize to the timeline.

Defaults to true.

pub async fn build(self) -> Result<Timeline, Error>

Create a Timeline with the options set on this builder.

Trait Implementations

impl Debug for TimelineBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.