Struct App 

pub struct App<D: Document> { /* private fields */ }

An app: name, document type and format, commands, views. run() opens the window; the same definition serves the CLI and MCP (App::cli) and tests (App::headless).

use ashlar_app::{App, Cx, Session};
use ashlar_command::{CommandError, CommandSpec};

#[derive(Clone, Default, serde::Serialize, serde::Deserialize)]
struct Doc { count: i64 }

fn bump(s: &mut Session<Doc>, _: &serde_json::Value) -> Result<serde_json::Value, CommandError> {
    s.edit("Bump", |d| d.count += 1);
    Ok(serde_json::Value::Null)
}

fn main() -> Result<(), ashlar_app::Error> {
    App::<Doc>::new("counter", "0.1.0")
        .command(CommandSpec::new("count.bump", "Bump", bump).menu(&["Edit"]).shortcut("Mod+B"))
        .view(|ui, cx: &mut Cx<'_, Doc>| {
            ui.label(format!("{}", cx.doc().count));
            if ui.button("Bump").clicked() {
                cx.dispatch("count.bump", serde_json::json!({}));
            }
        })
        .run()
}

Implementations

impl<D: Document> App<D>

pub fn new(name: impl Into<String>, version: impl Into<String>) -> Self

An app called name (lower case, used for folders, env vars and the CLI).

pub fn organization( self, qualifier: impl Into<String>, org: impl Into<String>, ) -> Self

Reverse-domain qualifier and organisation for the OS folders ("com", "Acme").

pub fn title(self, title: impl Into<String>) -> Self

Window title (default: the name).

pub fn format(self, format: Format<D>) -> Self

The document’s file format, with its migrations.

pub fn file_extension(self, ext: impl Into<String>) -> Self

A file extension offered by Open and Save dialogs (without the dot).

pub fn commands( self, specs: impl IntoIterator<Item = CommandSpec<Session<D>>>, ) -> Self

Add commands (menus follow declaration order).

pub fn command(self, spec: CommandSpec<Session<D>>) -> Self

pub fn view(self, view: impl FnMut(&mut Ui, &mut Cx<'_, D>) + 'static) -> Self

The UI, drawn inside the window’s central area each frame.

pub fn setup(self, f: impl FnOnce(&Context) + 'static) -> Self

Runs once before the first frame (install fonts, tokens).

pub fn autosave(self, every: Option<Duration>) -> Self

Autosave interval (None: no autosave or recovery). Default 60 s.

pub fn telemetry(self, key: impl Into<String>, endpoint: Option<&str>) -> Self

Telemetry (with the telemetry feature): write key and server. Always on when endpoint is set (no notice, no switches); TRACER_DISABLED in the environment turns it off.

pub fn instructions(self, text: impl Into<String>) -> Self

What MCP clients are told about the app.

pub fn dirs(self, dirs: AppDirs) -> Self

Put config, data, cache and logs here instead of the OS folders (tests, portable).

pub fn window_size(self, width: f32, height: f32) -> Self

pub fn control_port(self, port: u16) -> Self

Serve the control port on this port (also --control <port> and <APP>_CONTROL_PORT).

pub fn headless(self) -> Headless<D>

A session without a window, driving the same commands (tests, scripts).

pub fn runtime(self) -> Runtime<D>

The runtime without a window, for tests and benches: drive it with crate::Driver.

pub fn cli(self) -> Cli

The app’s -cli binary: commands, exec, run, mcp, serve, version, each on a fresh headless session (or the running app with --connect PORT). Add app verbs to the returned ashlar_cli::Cli before run().

pub fn run(self) -> Result<(), Error>

Open the window and run until it closes.