Struct Timeline

#[repr(transparent)]
pub struct Timeline {
    inner: TypedObjectRef<Timeline, ()>,
    phantom: PhantomData<()>,
}

All loaded items in a room.

There is no strict message ordering enforced by the Timeline; items will be appended/prepended to existing items in the order they are received by the server.

GLib type: GObject with reference counted clone semantics.

Fields

inner: TypedObjectRef<Timeline, ()>

phantom: PhantomData<()>

Implementations

impl Timeline

pub fn room(&self) -> <OnceCell<Room> as Property>::Value

The room containing this timeline.

pub fn items(&self) -> <OnceCell<FlattenListModel> as Property>::Value

The GListModel containing all the timeline items.

pub fn state(&self) -> <Cell<LoadingState> as Property>::Value

The loading state of the timeline.

pub fn is_loading_start(&self) -> <Cell<bool> as Property>::Value

Whether we are loading events at the start of the timeline.

pub fn is_empty(&self) -> <PhantomData<bool> as Property>::Value

Whether the timeline is empty.

pub fn preload(&self) -> <Cell<bool> as Property>::Value

Whether the timeline should be pre-loaded when it is ready.

pub fn set_preload<'a>( &self, value: impl Borrow<<<Cell<bool> as Property>::Value as HasParamSpec>::SetValue>, )

Whether the timeline should be pre-loaded when it is ready.

pub fn has_reached_start(&self) -> <Cell<bool> as Property>::Value

Whether we have reached the start of the timeline.

pub fn has_room_create(&self) -> <Cell<bool> as Property>::Value

Whether we have the m.room.create event in the timeline.

pub fn connect_room_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Listen for notifications of a change in the room property

pub fn connect_items_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Listen for notifications of a change in the items property

pub fn connect_state_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Listen for notifications of a change in the state property

pub fn connect_is_loading_start_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Listen for notifications of a change in the is-loading-start property

pub fn connect_is_empty_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Listen for notifications of a change in the is-empty property

pub fn connect_preload_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Listen for notifications of a change in the preload property

pub fn connect_has_reached_start_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Listen for notifications of a change in the has-reached-start property

pub fn connect_has_room_create_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Listen for notifications of a change in the has-room-create property

pub fn notify_room(&self)

Notify listeners of a change in the room property

pub fn notify_items(&self)

Notify listeners of a change in the items property

pub fn notify_state(&self)

Notify listeners of a change in the state property

pub fn notify_is_loading_start(&self)

Notify listeners of a change in the is-loading-start property

pub fn notify_is_empty(&self)

Notify listeners of a change in the is-empty property

pub fn notify_preload(&self)

Notify listeners of a change in the preload property

pub fn notify_has_reached_start(&self)

Notify listeners of a change in the has-reached-start property

pub fn notify_has_room_create(&self)

Notify listeners of a change in the has-room-create property

impl Timeline

pub(crate) fn new(room: &Room) -> Self

Construct a new Timeline for the given room.

pub(crate) fn matrix_timeline(&self) -> Arc<SdkTimeline>

The underlying SDK timeline.

pub(crate) async fn paginate_backwards<F>(&self, continue_fn: F)

where F: Fn() -> ControlFlow<()>,

Load more events at the start of the timeline until the given function tells us to stop.

pub(crate) fn event_by_identifier( &self, identifier: &TimelineEventItemId, ) -> Option<Event>

Get the event with the given identifier from this Timeline.

Use this method if you are sure the event has already been received. Otherwise use fetch_event_by_id.

pub(crate) fn find_event_position( &self, identifier: &TimelineEventItemId, ) -> Option<usize>

Get the position of the event with the given identifier in this Timeline.

pub(crate) fn remove_empty_typing_row(&self)

Remove the typing row from the timeline.

pub(crate) async fn has_unread_messages(&self) -> Option<bool>

Whether this timeline has unread messages.

Returns None if it is not possible to know, for example if there are no events in the Timeline.

pub(crate) fn redactable_events_for( &self, user_id: &UserId, ) -> Vec<OwnedEventId>

The IDs of redactable events sent by the given user in this timeline.

fn emit_read_change_trigger(&self)

Emit the trigger that a read change might have occurred.

pub(crate) fn connect_read_change_trigger<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Connect to the trigger emitted when a read change might have occurred.

Trait Implementations

impl Clone for Timeline

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Timeline

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

Formats the value using the given formatter.

impl HasParamSpec for Timeline

type ParamSpec = ParamSpecObject

type SetValue = Timeline

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, Timeline>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Timeline

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ObjectSubclassIs for Timeline

type Subclass = Timeline

impl Ord for Timeline

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Timeline

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Timeline

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Timeline

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Timeline

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Timeline