Skip to main content

Module runtime

Module runtime 

Source
Expand description

Running applications: the App trait, Commands, the terminal Runtime and the test Harness.

Structs§

Command
Work for the runtime, returned from App::update.
Confirm
A question for Command::confirm: a title, an optional message, and the messages for the answers.
DetachedHandoff
Hands the terminal to a program until it writes its first line on standard output, then takes the screen back and leaves the program running in the background as a LiveChild.
FrameLimit
How many frames a second the runtime draws at most, for a local and for a remote connection.
Handoff
Hands the terminal to another program: leaves raw mode and the alternate screen, runs it attached to the real terminal, then takes the screen back and draws everything again.
HandoffRequest
A handoff a Harness recorded instead of running.
Harness
Runs an App against an in-memory screen.
LiveChild
A program a DetachedHandoff left running: its standard input is the application’s to write, its later output arrives as messages through DetachedHandoff::on_line.
Process
A child process whose output is read line by line, for showing in a log view.
Runtime
Configures and runs an application in the terminal.
Task
Work to run in the background with progress, cancellation and an outcome.
TaskCx
What running work can do: report progress, send messages, notice cancellation and sleep.
TaskEntry
One task as the application shows it.
TaskId
Identifies one task for its whole life. Ids are unique within the process.
Tasks
Tasks an application shows, kept up to date with Tasks::apply. Newest last.
TestChild
The test’s side of the stand-in from LiveChild::for_tests: it plays the program.

Enums§

ChildLine
What a LiveChild says, delivered through DetachedHandoff::on_line.
ClipboardEvent
Something that happened on the clipboard, delivered to App::clipboard.
DetachedOutcome
How a DetachedHandoff ended.
HandoffOutcome
How a handoff ended.
Line
Where a line came from. With a pseudo-terminal both streams share one line, so only Line::Out appears.
ProcessOutcome
How the child ended.
TaskEvent
What happened to a task, delivered through Task::on_event.
TaskOutcome
How a task ended.
Termination
Why the system, rather than the user, is ending the application.

Traits§

App
An application built with quvyta-framework: data, a function that draws it and a function that changes it.

Functions§

html_page
Wraps Harness::html fragments in an HTML document that lays screens out on a dark page.