Struct matrix_sdk_ui :: timeline :: TimelineBuilder Copy item path

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 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. Read more

Auto Trait Implementations§

impl !UnwindSafe for TimelineBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

const WITNESS: W = W::MAKE

A constant of the type witness

impl<T> Identity for T
where T: ?Sized,

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more