Struct Documents 

pub struct Documents { /* private fields */ }

Every open document + which one is active. Always holds AT LEAST ONE document: closing the last tab leaves a fresh untitled one in its place, so Documents::engine_mut is infallible and the shell never has to render a “no document” state that would be an empty viewport with extra steps.

Implementations

impl Documents

pub fn new(new_engine: EngineFactory) -> Self

A session holding ONE empty document built by new_engine.

pub fn spawn_engine(&self) -> EngineState

A fresh engine for a document about to be opened — the caller loads into it and hands the result to Self::open_document.

Seeded with the WHOLE of the session’s settings, workbench included, so a new tab continues what you were doing. The load that follows overrides the workbench if the document names one (see the module header).

pub fn engine(&self) -> &EngineState

pub fn engine_mut(&mut self) -> &mut EngineState

pub fn active(&self) -> &Document

pub fn active_mut(&mut self) -> &mut Document

pub fn active_index(&self) -> usize

pub fn active_id(&self) -> u64

The ACTIVE document’s handle — the shell compares it frame to frame to notice a switch from ANY source (a tab click, a close, New, Open, Open Part, the session restore) with one check instead of a hook per site.

pub fn len(&self) -> usize

pub fn get(&self, index: usize) -> Option<&Document>

pub fn get_mut(&mut self, index: usize) -> Option<&mut Document>

pub fn iter(&self) -> Iter<'_, Document>

pub fn iter_mut(&mut self) -> IterMut<'_, Document>

pub fn index_of(&self, name: &str) -> Option<usize>

The tab holding the document stored under name, if any.

pub fn focus_named(&mut self, name: &str) -> bool

Activate the tab already holding name; false when it is not open. The “focus the existing tab” half of open-or-focus.

pub fn open_document(&mut self, doc: Document) -> usize

Add doc as a new tab and make it active.

pub fn activate(&mut self, index: usize)

Make tab index active, carrying the session’s display settings over to it. Out-of-range indices are ignored (a stale click never panics).

pub fn close(&mut self, index: usize)

Close tab index. Closing the LAST document leaves a fresh untitled one (the always-one-document invariant); closing a tab before the active one keeps the same document active at its new index.

The caller is responsible for the unsaved-changes prompt — this is the mechanical close (panels::file owns the confirmation).

pub fn refresh_dirty_markers(&mut self)

Refresh every tab’s dirty dot (see Document::refresh_dirty_marker).

pub fn session_json(&self) -> String

The persisted session: the NAMED documents in tab order plus the active one’s name. A never-saved document has no store identity, so it cannot be restored and is not listed — reloading loses an unsaved scratch document exactly as it did when the app held one document and persisted none.

pub fn restore_session(&mut self, store: &dyn ModelStore, json: &str) -> usize

Restore a persisted session, REPLACING the current open list. Names the store no longer holds (or cannot load) are skipped — a deleted file must not stop the rest of the session coming back — and the count of documents actually restored is returned, so the caller can seed instead when it is 0.