Struct Editor 

pub struct Editor { /* private fields */ }

Editing a program: see the module docs.

Implementations

impl Editor

pub fn new(registry: Registry, files: impl FileStoreMut + 'static) -> Self

An editor of what registry offers, editing a program of no steps, the files it places parts from read from files, what they are made into kept in memory.

pub fn with_cache( registry: Registry, files: impl FileStoreMut + 'static, cache: Cache, ) -> Self

Editor::new, what its files are made into kept in cache: a host process’s, kept on disk too.

pub fn program(&self) -> &Program

pub fn forget_viewer(&mut self)

Forgets what the viewer was sent: the next update sends all of the scene, as to a viewer that has nothing — one starting afresh, or one that never saw the updates someone else asked for (see crate::agent::Session::new).

pub fn registry(&self) -> &Registry

What it offers.

pub fn part(&self) -> Reader<'_>

The part the program builds, as far as it runs now.

pub fn counts(&self) -> Counts

How much work its runs have done: what a test bounds an edit by.

pub fn editing(&self) -> Option<&ProgramStep>

The step being edited, with its arguments as they now are.

pub fn step_editor(&self) -> Option<&StepEditor>

The step editor of the step being edited: its operation’s editing state among what it keeps.

pub fn tool<T: Tool>(&self) -> Option<&T>

The tool in hand, if it is a T.

pub fn handle_json(&mut self, command: &str) -> Result<String, String>

Editor::handle on the wire: command is a Command as JSON, and the answer an Update as JSON. Shared by every front end that is not Rust (the browser’s wasm module, the VS Code host process), so they all speak the same protocol. Err is a message that is not itself an update: the command could not be read, or the update not written.

pub fn handle(&mut self, command: Command) -> Update

Applies command, and says what to show now.