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

docs: resolved https://codeberg.org/fogti notes

This commit is contained in:
hakki 2024-11-09 12:54:51 +01:00 committed by mikolaj
parent aae99a9656
commit 7a01a76738
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/autorouter/invoker.rs
View File

@ -55,8 +55,7 @@ pub trait GetObstacles {
/// Error types that can occur during the invocation of commands /// Error types that can occur during the invocation of commands
#[derive(Error, Debug, Clone)] #[derive(Error, Debug, Clone)]
pub enum InvokerError { pub enum InvokerError {
/// Wraps errors related to command history operations /// Wraps errors related to command history operations
#[error(transparent)] #[error(transparent)]
History(#[from] HistoryError), History(#[from] HistoryError),
@ -67,13 +66,13 @@ pub enum InvokerError {
} }
#[derive(Getters, Dissolve)] #[derive(Getters, Dissolve)]
/// Structure that manages the execution of commands within the autorouting system /// Structure that manages the execution and history of commands within the autorouting system
pub struct Invoker<M: AccessMesadata> { pub struct Invoker<M: AccessMesadata> {
/// The structure instance used for executing commands /// Returns an reference to used [`Autorouter`] executor
pub(super) autorouter: Autorouter<M>, pub(super) autorouter: Autorouter<M>,
/// History of executed commands /// Returns a reference to [`History`] of executed commands
pub(super) history: History, pub(super) history: History,
/// Currently executed command. /// Returns a reference to currently ongoing command type.
pub(super) ongoing_command: Option<Command>, pub(super) ongoing_command: Option<Command>,
} }
@ -94,6 +93,9 @@ impl<M: AccessMesadata> Invoker<M> {
//#[debug_requires(self.ongoing_command.is_none())] //#[debug_requires(self.ongoing_command.is_none())]
/// Executes a command, managing the command status and history /// Executes a command, managing the command status and history
///
/// This function is used to pass the [`Command`] to [`Invoker::execute_stepper`]
/// function, and control its execution status
pub fn execute(&mut self, command: Command) -> Result<(), InvokerError> { pub fn execute(&mut self, command: Command) -> Result<(), InvokerError> {
let mut execute = self.execute_stepper(command)?; let mut execute = self.execute_stepper(command)?;
@ -109,6 +111,8 @@ impl<M: AccessMesadata> Invoker<M> {
#[debug_requires(self.ongoing_command.is_none())] #[debug_requires(self.ongoing_command.is_none())]
/// Pass given command to be executed /// Pass given command to be executed
///
/// Function used to set given [`Command`] to ongoing state, dispatch and execute it
pub fn execute_stepper(&mut self, command: Command) -> Result<ExecutionStepper, InvokerError> { pub fn execute_stepper(&mut self, command: Command) -> Result<ExecutionStepper, InvokerError> {
let execute = self.dispatch_command(&command); let execute = self.dispatch_command(&command);
self.ongoing_command = Some(command); self.ongoing_command = Some(command);
@ -174,7 +178,7 @@ impl<M: AccessMesadata> Invoker<M> {
Ok(self.history.undo()?) Ok(self.history.undo()?)
} }
//#[debug_requires(self.ongoing.is_none())] //#[debug_requires(self.ongoing_command.is_none())]
/// Redo last command /// Redo last command
pub fn redo(&mut self) -> Result<(), InvokerError> { pub fn redo(&mut self) -> Result<(), InvokerError> {
let command = self.history.last_undone()?.clone(); let command = self.history.last_undone()?.clone();