Add some client docs

This commit is contained in:
Arne Beer 2020-11-25 19:10:29 +01:00
parent 425bf00881
commit b0206834a0

View file

@ -93,8 +93,10 @@ impl Client {
/// in their own functions with their own communication code.
/// Such functionalities includes reading local filestand sending multiple messages.
///
/// Returns `true`, if the current command has been handled by this function.
/// Returns `Ok(true)`, if the current command has been handled by this function.
/// This indicates that the client can now shut down.
/// If `Ok(false)` is returned, the client will continue and handle the Subcommand in the
/// [handle_simple_command] function.
async fn handle_complex_command(&mut self) -> Result<bool> {
// This match handles all "complex" commands.
match &self.opt.cmd {