Struct biodivine_sketchbook::app::state::editor::EditorSession

pub struct EditorSession {
    id: String,
    undo_stack: UndoStack,
    tab_bar: TabBarState,
    sketch: Sketch,
}

The state of one editor session.

An editor session is the “main” app session where a model is created/edited and from which other sessions can be started.

Fields

id: String

undo_stack: UndoStack

tab_bar: TabBarState

sketch: Sketch

Implementations

impl EditorSession

pub fn new(id: &str) -> EditorSession

Trait Implementations

impl SessionHelper for EditorSession

fn starts_with<'a, 'b>( prefix: &str, at_path: &'a [&'b str], ) -> Option<&'a [&'b str]>

A utility function which checks if at_path starts with a specific first segment. If yes, returns the remaining part of the path.

fn matches(expected: &[&str], at_path: &[&str]) -> bool

A utility function which checks if at_path is exactly

fn invalid_path_error_generic<T>(at_path: &[&str]) -> Result<T, DynError>

A utility function which emits a generic “invalid path” error.

fn invalid_path_error_specific<T>( path: &[&str], component: &str, ) -> Result<T, DynError>

A utility function which emits a “invalid path” error mentioning specific state’s component.

fn clone_payload_str(event: &Event, component: &str) -> Result<String, DynError>

A utility function to get and clone a payload of an event. Errors if payload is empty.

fn assert_path_length( path: &[&str], length: usize, component: &str, ) -> Result<(), DynError>

A utility function to assert that path has a given length, or emit a DynError otherwise.

fn assert_payload_empty(event: &Event, component: &str) -> Result<(), DynError>

A utility function to assert that payload is empty - otherwise, DynError is emitted.

impl SessionState for EditorSession

fn perform_event( &mut self, event: &Event, at_path: &[&str], ) -> Result<Consumed, DynError>

Modify the session state using the provided event. The possible outcomes are described by Consumed.

fn refresh( &self, full_path: &[String], at_path: &[&str], ) -> Result<Event, DynError>

“Read” session state into an event without modifying it.

impl StackSession for EditorSession

fn process_message( &mut self, message: &SessionMessage, ) -> Result<(Option<SessionMessage>, Option<StateChange>), DynError>

Process a message sent to this session state object.

fn id(&self) -> &str

Returns the string identifier of this particular session. Each session identifier must be unique within the application.

fn undo_stack_mut(&mut self) -> &mut UndoStack

Returns a mutable reference to session’s undo stack.

fn undo_stack(&self) -> &UndoStack

Returns an immutable reference to session’s undo stack.

fn perform_action( &mut self, action: &UserAction, ) -> Result<StateChange, DynError>

Perform a user action on this session state object. This usually involves propagating the events to the internal SessionState objects and collecting the results into a single StateChange entry.

fn perform_categorized_action( &mut self, action: &UserAction, ignore_stack: bool, ) -> Result<StateChange, DynError>

Perform a user action on this session state object, with additional information whether the action should bypass the undo-redo stack.

fn append_stack_updates(&self, state_changes: &mut Vec<Event>)