Struct App

pub(crate) struct App {
    pub(crate) client: Client,
    pub(crate) sync_service: Arc<SyncService>,
    pub(crate) ui_rooms: Arc<Mutex<HashMap<OwnedRoomId, Room>>>,
    pub(crate) timelines: Arc<Mutex<HashMap<OwnedRoomId, Timeline>>>,
    pub(crate) room_list_rooms: StatefulList<Room>,
    pub(crate) room_info: Arc<Mutex<HashMap<OwnedRoomId, ExtraRoomInfo>>>,
    pub(crate) listen_task: JoinHandle<()>,
    pub(crate) last_status_message: Arc<Mutex<Option<String>>>,
    pub(crate) clear_status_message: Option<JoinHandle<()>>,
    pub(crate) details_mode: DetailsMode,
    pub(crate) current_room_subscription: Option<Room>,
    pub(crate) current_pagination: Arc<Mutex<Option<JoinHandle<()>>>>,
}

Fields

client: Client

Reference to the main SDK client.

sync_service: Arc<SyncService>

The sync service used for synchronizing events.

ui_rooms: Arc<Mutex<HashMap<OwnedRoomId, Room>>>

Room list service rooms known to the app.

timelines: Arc<Mutex<HashMap<OwnedRoomId, Timeline>>>

Timelines data structures for each room.

room_list_rooms: StatefulList<Room>

Ratatui’s list of room list rooms.

room_info: Arc<Mutex<HashMap<OwnedRoomId, ExtraRoomInfo>>>

Extra information about rooms.

listen_task: JoinHandle<()>

Task listening to room list service changes, and spawning timelines.

last_status_message: Arc<Mutex<Option<String>>>

Content of the latest status message, if set.

clear_status_message: Option<JoinHandle<()>>

A task to automatically clear the status message in N seconds, if set.

details_mode: DetailsMode

What’s shown in the details view, aka the right panel.

current_room_subscription: Option<Room>

The current room that’s subscribed to in the room list’s sliding sync.

current_pagination: Arc<Mutex<Option<JoinHandle<()>>>>

Implementations

impl App

pub(crate) async fn new(client: Client) -> Result<Self>

impl App

pub(crate) fn set_status_message(&mut self, status: String)

Set the current status message (displayed at the bottom), for a few seconds.

pub(crate) async fn mark_as_read(&mut self)

Mark the currently selected room as read.

pub(crate) async fn toggle_reaction_to_latest_msg(&mut self)

pub(crate) fn back_paginate(&mut self)

Run a small back-pagination (expect a batch of 20 events, continue until we get 10 timeline items or hit the timeline start).

pub(crate) fn get_selected_room_id( &self, selected: Option<usize>, ) -> Option<OwnedRoomId>

Returns the currently selected room id, if any.

pub(crate) fn subscribe_to_selected_room(&mut self, selected: usize)

pub(crate) async fn render_loop( &mut self, terminal: Terminal<impl Backend>, ) -> Result<()>

pub(crate) async fn run( &mut self, terminal: Terminal<impl Backend>, ) -> Result<()>

impl App

pub(crate) fn render_title(&self, area: Rect, buf: &mut Buffer)

Render the top square (title of the program).

pub(crate) fn render_left(&mut self, area: Rect, buf: &mut Buffer)

Renders the left part of the screen, that is, the list of rooms.

pub(crate) fn render_right(&mut self, area: Rect, buf: &mut Buffer)

Render the right part of the screen, showing the details of the current view.

pub(crate) fn render_timeline( &mut self, room_id: &RoomId, inner_block: Block<'_>, inner_area: Rect, buf: &mut Buffer, ) -> bool

Renders the list of timeline items for the given room.

pub(crate) fn render_footer(&self, area: Rect, buf: &mut Buffer)

Render the bottom part of the screen, with a status message if one is set, or a default help message otherwise.

Trait Implementations

impl Widget for &mut App

fn render(self, area: Rect, buf: &mut Buffer)

Render the whole app.