Struct Commands 

pub struct Commands<S> { /* private fields */ }

Houses your commands. See CommandHandler for more details

Note

Your handler will only be called if it could match your CommandHandler::args().

To run commands, you need to have a second binary which does the same (or calls) the [crate::Quokka::execute_command] function.

Running the [crate::Quokka::serve] in a subcommand could possibly also work, but this is something I have not tested and sounds somewhat wrong.

Example

use quokka_command::{Commands, CommandHandler, Result, Error};
use quokka_state::FromState;
use clap::Command;

#[derive(Clone)]
struct TestState;

struct TestHandler;

impl<S> FromState<S> for TestHandler {
    fn from_state(input: &S) -> Self {
        Self
    }
}

impl CommandHandler for TestHandler {
    type Error = Error;

    fn args() -> clap::Command {
        Command::new("test-command")
    }

    async fn call(self, _: clap::ArgMatches) -> Result<()> {
        Ok(())
    }
}

let mut cmds = Commands::default();

cmds.register_command::<TestHandler>();
cmds.dispatch(TestState, ["test-command"]);

Implementations

impl<S: Send + Sync + Clone + 'static> Commands<S>

pub fn register_command<C: CommandHandler + 'static>(&mut self)

where S: ProvideState<C>,

pub async fn dispatch<I, T>(self, state: S, args: I) -> Result<()>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

pub fn build_clap_command(&self) -> Command

Trait Implementations

impl<S: Clone> Clone for Commands<S>

fn clone(&self) -> Commands<S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S> Debug for Commands<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> Default for Commands<S>

fn default() -> Self

Returns the “default value” for a type.

impl<S> TryFromConfig for Commands<S>

type Error = Error

async fn try_from_config(_: &Config) -> Result<Self>

where Self: Sized,

Simplifies building from the root config struct