Thanks to visit codestin.com
Credit goes to github.com

Skip to content

break down shell run loop into update and finish #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Utagai merged 2 commits into from
Aug 28, 2025
Merged

break down shell run loop into update and finish #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43d7644
break down shell run loop into update and finish
LanHikari22 Aug 28, 2025
da7f2ca
fix inverted logic when deciding to break on update
LanHikari22 Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 43 additions & 11 deletions src/shell.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,15 +204,19 @@ impl<'a, S> Shell<'a, S> {
}
}

/// Executes the shell's run-loop.
///
/// This will run indefinitely until the user exits, otherwise terminates the shell or
/// process or the shell encounters an error and stops.

/// Executes the shell's run-loop but only once.
///
/// Note that invalid command invocations, e.g., nonexistent commands, are not considered fatal
/// errors and do _not_ cause a return from this method.
pub fn run(&mut self) -> Result<()> {
while !self.terminate {
/// This relies on the caller to call it repeatedly to keep the shell operational.
///
/// Returns
/// - Ok(true) on successful service. Caller should call update again.
/// - Ok(false) on successful service, but request by user to exit the shell.
/// - Err on any unhandled errors that should terminate the shell. This should result in no
/// longer calling update by the caller.
///
pub fn update(&mut self) -> Result<bool> {
if !self.terminate {
let input = self.rl.readline(self.prompt);

match input {
Expand All @@ -222,23 +226,51 @@ impl<'a, S> Shell<'a, S> {
},
Err(ReadlineError::Interrupted) => {
println!("-> CTRL+C; bye.");
break;
return Ok(false);
}
Err(ReadlineError::Eof) => {
println!("-> CTRL+D; bye.");
break;
return Ok(false);
}
Err(err) => {
println!("Error: {:?}", err);
break;
return Err(ShiError::general(err.to_string()));
}
}
}

Ok(true)
}

/// The caller calls this after update routines finish servicing. This performs final computations
/// before exit.
pub fn finish(&mut self) -> Result<()> {

self.save_history()?;

Ok(())
}

/// Executes the shell's run-loop.
///
/// This will run indefinitely until the user exits, otherwise terminates the shell or
/// process or the shell encounters an error and stops.
///
/// Note that invalid command invocations, e.g., nonexistent commands, are not considered fatal
/// errors and do _not_ cause a return from this method.
pub fn run(&mut self) -> Result<()> {
while !self.terminate {
let update_again = self.update()?;

if ! update_again {
break;
}
}

self.finish()?;

Ok(())
}
}

#[cfg(test)]
Expand Down
Loading