Struct App 

pub struct App { /* private fields */ }

The application: owns all state and drives the event loop.

Implementations

impl App

pub fn open_export_modal(&mut self)

Open the export options modal.

Builds one ExportJob per format — HTML first, then every custom converter CustomExportEntry::config_problem did not flag — cloned from config now, so a later reload can’t change what the chosen format runs.

Seeded from [export.html]: the title from the document’s first H1 (else the file stem), and the stylesheet pill from Default plus every .css in <config_dir>/export/. Those options apply to every format, since the HTML is what a custom command converts.

impl App

pub fn open_export_theme_modal(&mut self)

Push the export-theme modal, listing every built-in plus any user-authored theme in themes/.

impl App

pub fn open_markdown_cheat_sheet(&mut self)

Open the Markdown syntax cheat-sheet popover.

pub fn open_about_modal(&mut self)

Open the About page. Touches no network — its [ Check for updates ] button is the only thing that reaches GitHub (see App::open_update_modal).

pub fn open_command_palette(&mut self)

Open the fuzzy-searchable command palette.

pub fn dispatch_action( &mut self, action: Action, doc_height: usize, doc_width: usize, )

Dispatch a resolved Action through the unified pipeline. The run-loop keystroke arm and the command palette both funnel through here, so handle_app_action, the dirty-quit guard, edit_ops::apply, scroll tracking, flashes, and link-follow draining are sequenced in exactly one place.

pub fn enter_read_only_diff(&mut self, old: String, new: String) -> bool

Install a read-only review of old vs new and enter diff mode — the --diff difftool presentation.

Separate from Self::enter_diff_mode rather than a flag on it: there is no vim command line to tear down, no search flow to end, and no intro modal (it teaches an accept/reject vocabulary this review lacks). What it shares is DiffState::new refusing an empty hunk list and EditorState::enter_diff_mode as the single door into Mode::Diff.

The buffer is seeded with the old side so the review reads like every other one (buffer = before, new_buffer = after). dirty stays false and file_path stays None, so nothing has a path to save over.

false when the two files are byte-identical: git invokes a difftool only for paths it believes differ, but a whitespace- or mode-only change can still reach us.

pub fn set_diff_label(&mut self, label: Option<String>)

Set the status-bar label for a difftool session (see App::diff_label).

pub fn open_settings_overlay(&mut self)

Open the settings overlay.

pub fn open_welcome_modal(&mut self)

Open the welcome modal on demand, ignoring config.editor.show_welcome and rebuilding from the live capabilities — so it doubles as the “my terminal changed” entry point. Guarded against stacking two copies.

pub fn open_theme_picker(&mut self)

Open the fuzzy-searchable theme picker; selecting a row writes config.theme, saves, and reapplies the palette live.

pub fn open_keybinds_overlay(&mut self)

Open the keybinds overlay, building a live KeyMap if there isn’t one yet.

pub fn open_insert_table_modal(&mut self)

Open the rows/columns prompt. The caller must have verified the location precondition via crate::editor::table_edit::can_insert_table.

pub fn open_save_as_modal(&mut self, after_save: Option<AfterSave>)

Open the “Save As” path-entry modal, seeded from the buffer’s current path. On submit the buffer is written and re-pointed via Self::save_buffer_as; after_save then runs, which is how the save-then-quit / save-then-navigate flows finish a deferred action.

impl App

pub fn flash(&mut self, text: impl Into<String>, kind: MessageKind)

Emit a transient hint-line message for passive confirmations the user can safely miss. Use Self::notify for anything that needs acknowledgement.

pub fn notify(&mut self, text: impl Into<String>, kind: ModalKind)

Surface a sticky NoticeModal on top of whatever modal triggered it.

impl App

pub fn open_post_upgrade_modal(&mut self)

Open the release notes on demand — the About page’s [ Release notes ] button.

Always shows the modal, even without a changelog section for this version: a question the user just asked gets answered. Reads and writes no bookkeeping — looking is not being notified, so this neither arms nor disarms the startup notice.

impl App

pub fn open_search_modal(&mut self)

Open the search/replace modal, pre-filled from (and tearing down) any active flow.

impl App

pub fn open_section_picker(&mut self, doc_width: usize)

Open the “Go to section” modal, preselecting the nearest heading at or before the cursor.

doc_width must be the live document area width, so the modal’s previewed target_scroll lands at the same row the editor will paint.

impl App

pub fn open_update_modal(&mut self)

Open the update modal on demand (About page button, CheckForUpdates action).

Always re-fetches, ignoring the daily throttle — that gate bounds unattended chatter. A cached positive result (Inconclusive included) is shown meanwhile so the modal isn’t blank; a cached failure is not, since answering a just-asked question with a stale “couldn’t check” is worse than showing the fetch in progress.

impl App

pub fn new( config: Config, state: State, keybindings: KeyBindingOverrides, theme_file: ThemeFile, file_path: Option<PathBuf>, capabilities: Capabilities, config_warnings: Vec<ConfigWarning>, ) -> Result<Self>

Create the app, loading the file if one is given.

pub fn with_startup_anchor(self, anchor: Option<String>) -> Self

Record the #section the command line named, applied on the first frame. A builder rather than a new parameter: only main sets it, and every other site wants the default.

pub fn with_clipboard(self, clipboard: Box<dyn ClipboardSource>) -> Self

Install the clipboard the app reads and writes — main passes crate::clipboard::default_source. A builder for the same reason as Self::with_startup_anchor, and so that nothing else reaches the real clipboard.

pub fn capabilities(&self) -> &Capabilities

Expose detected capabilities to later phases (mouse, images, etc.).

pub fn run( &mut self, terminal: Terminal<CrosstermBackend<Stdout>>, ) -> Result<()>

Run the event loop until the user quits. The body is deliberately a flat sequence of named calls into [event_loop], so the control flow is legible at a glance.

pub fn diff_stop_walk(&self) -> bool

True when a difftool session ended via Quit — see App::diff_stop_walk.