berkus
/
topola
mirror of https://codeberg.org/topola/topola.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(interactor): document interactor.rs

This commit is contained in:
Szpachlarz 2024-11-15 19:09:37 +00:00 committed by mikolaj
parent 566ce37a6b
commit 6f2e6bd70e
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/interactor/interactor.rs
View File

@ -16,12 +16,14 @@ use crate::{
stepper::{Abort, Step}, stepper::{Abort, Step},
}; };
/// Structure that manages the invoker and activities
pub struct Interactor<M: AccessMesadata> { pub struct Interactor<M: AccessMesadata> {
invoker: Invoker<M>, invoker: Invoker<M>,
activity: Option<ActivityStepperWithStatus>, activity: Option<ActivityStepperWithStatus>,
} }
impl<M: AccessMesadata> Interactor<M> { impl<M: AccessMesadata> Interactor<M> {
/// Create a new instance of Interactor with the given Board instance
pub fn new(board: Board<M>) -> Result<Self, InsertionError> { pub fn new(board: Board<M>) -> Result<Self, InsertionError> {
Ok(Self { Ok(Self {
invoker: Invoker::new(Autorouter::new(board)?), invoker: Invoker::new(Autorouter::new(board)?),
@ -29,10 +31,12 @@ impl<M: AccessMesadata> Interactor<M> {
}) })
} }
/// Execute a command
pub fn execute(&mut self, command: Command) -> Result<(), InvokerError> { pub fn execute(&mut self, command: Command) -> Result<(), InvokerError> {
self.invoker.execute(command) self.invoker.execute(command)
} }
/// Start executing an activity
pub fn schedule(&mut self, command: Command) -> Result<(), InvokerError> { pub fn schedule(&mut self, command: Command) -> Result<(), InvokerError> {
self.activity = Some(ActivityStepperWithStatus::new_execution( self.activity = Some(ActivityStepperWithStatus::new_execution(
self.invoker.execute_stepper(command)?, self.invoker.execute_stepper(command)?,
@ -40,14 +44,17 @@ impl<M: AccessMesadata> Interactor<M> {
Ok(()) Ok(())
} }
/// Undo last command
pub fn undo(&mut self) -> Result<(), InvokerError> { pub fn undo(&mut self) -> Result<(), InvokerError> {
self.invoker.undo() self.invoker.undo()
} }
/// Redo last command
pub fn redo(&mut self) -> Result<(), InvokerError> { pub fn redo(&mut self) -> Result<(), InvokerError> {
self.invoker.redo() self.invoker.redo()
} }
/// Abort the currently running execution or activity
pub fn abort(&mut self) { pub fn abort(&mut self) {
if let Some(ref mut activity) = self.activity { if let Some(ref mut activity) = self.activity {
activity.abort(&mut ActivityContext::<M> { activity.abort(&mut ActivityContext::<M> {
@ -60,10 +67,12 @@ impl<M: AccessMesadata> Interactor<M> {
} }
} }
/// Replay last command
pub fn replay(&mut self, history: History) { pub fn replay(&mut self, history: History) {
self.invoker.replay(history); self.invoker.replay(history);
} }
/// Update the currently running execution or activity
pub fn update( pub fn update(
&mut self, &mut self,
interactive_input: &InteractiveInput, interactive_input: &InteractiveInput,
@ -84,10 +93,12 @@ impl<M: AccessMesadata> Interactor<M> {
ControlFlow::Break(Ok(())) ControlFlow::Break(Ok(()))
} }
/// Returns the invoker
pub fn invoker(&self) -> &Invoker<M> { pub fn invoker(&self) -> &Invoker<M> {
&self.invoker &self.invoker
} }
/// Returns the currently running activity
pub fn maybe_activity(&self) -> &Option<ActivityStepperWithStatus> { pub fn maybe_activity(&self) -> &Option<ActivityStepperWithStatus> {
&self.activity &self.activity
} }