Struct JoinedRoomDetails

pub struct JoinedRoomDetails {
    pub timeline: Arc<Timeline>,
    pub timeline_update_sender: Sender<TimelineUpdate>,
    pub timeline_singleton_endpoints: Option<(Receiver<TimelineUpdate>, TimelineRequestSender)>,
    pub typing_notice_subscriber: Option<EventHandlerDropGuard>,
    /* private fields */
}

Backend-specific details about a joined room that our client currently knows about.

Fields

timeline: Arc<Timeline>

A reference to this room’s timeline of events.

timeline_update_sender: Sender<TimelineUpdate>

An instance of the clone-able sender that can be used to send updates to this room’s timeline.

timeline_singleton_endpoints: Option<(Receiver<TimelineUpdate>, TimelineRequestSender)>

A tuple of two separate channel endpoints that can only be taken once by the main UI thread.

1. The single receiver that can receive updates to this room’s timeline.
   • When a new room is joined, an unbounded crossbeam channel will be created and its sender given to a background task (the timeline_subscriber_handler()) that enqueues timeline updates as it receives timeline vector diffs from the server.
   • The UI thread can take ownership of this update receiver in order to receive updates to this room’s timeline, but only one receiver can exist at a time.
2. The sender that can send requests to the background timeline subscriber handler, e.g., to watch for a specific event to be prepended to the timeline (via back pagination).

typing_notice_subscriber: Option<EventHandlerDropGuard>

A drop guard for the event handler that represents a subscription to typing notices for this room.

Trait Implementations

impl Drop for JoinedRoomDetails

fn drop(&mut self)

Executes the destructor for this type.