Struct Clier 

pub struct Clier<T, R> {
    pub args: Argv,
    /* private fields */
}

Clier is the main struct for the framework

Fields

args: Argv

Parsed arguments from the command line

Implementations

impl Clier<HasMeta, Runnable>

pub fn run(self) -> ExitCode

.

Examples found in repository

examples/framework.rs (line 22)

fn main() {
  let clier_builder = Clier::parse().meta(CliMeta {
    name: "example-clier".into(),
    usage: Some("[command]".into()),
    description: "testing".into(),
    version: Some("0.0.0".into()),
  });

  let app = clier_builder.runnable(vec![Commands::Collection(CmdCollection {
    meta: CmdMeta::new("testing", "testing"),
    children: Box::from([Commands::Command {
      meta: CmdMeta::new("testchild", "testing"),
      handler: |_| {
        println!("hello");
        ExitCode(0)
      },
    }]),
  })]);

  app.run();
}

impl Clier<HasMeta, NotRunnable>

pub fn runnable(self, cmds: Vec<Commands>) -> Clier<HasMeta, Runnable>

TODO

Examples found in repository

examples/framework.rs (lines 11-20)

fn main() {
  let clier_builder = Clier::parse().meta(CliMeta {
    name: "example-clier".into(),
    usage: Some("[command]".into()),
    description: "testing".into(),
    version: Some("0.0.0".into()),
  });

  let app = clier_builder.runnable(vec![Commands::Collection(CmdCollection {
    meta: CmdMeta::new("testing", "testing"),
    children: Box::from([Commands::Command {
      meta: CmdMeta::new("testchild", "testing"),
      handler: |_| {
        println!("hello");
        ExitCode(0)
      },
    }]),
  })]);

  app.run();
}

impl Clier<MissingMeta, NotRunnable>

pub fn meta(self, meta: CliMeta) -> Clier<HasMeta, NotRunnable>

.

Examples found in repository

examples/framework.rs (lines 4-9)

fn main() {
  let clier_builder = Clier::parse().meta(CliMeta {
    name: "example-clier".into(),
    usage: Some("[command]".into()),
    description: "testing".into(),
    version: Some("0.0.0".into()),
  });

  let app = clier_builder.runnable(vec![Commands::Collection(CmdCollection {
    meta: CmdMeta::new("testing", "testing"),
    children: Box::from([Commands::Command {
      meta: CmdMeta::new("testchild", "testing"),
      handler: |_| {
        println!("hello");
        ExitCode(0)
      },
    }]),
  })]);

  app.run();
}

pub fn parse() -> Clier<MissingMeta, NotRunnable>

Create a new Clier instance and parsing

Examples found in repository

examples/framework.rs (line 4)

fn main() {
  let clier_builder = Clier::parse().meta(CliMeta {
    name: "example-clier".into(),
    usage: Some("[command]".into()),
    description: "testing".into(),
    version: Some("0.0.0".into()),
  });

  let app = clier_builder.runnable(vec![Commands::Collection(CmdCollection {
    meta: CmdMeta::new("testing", "testing"),
    children: Box::from([Commands::Command {
      meta: CmdMeta::new("testchild", "testing"),
      handler: |_| {
        println!("hello");
        ExitCode(0)
      },
    }]),
  })]);

  app.run();
}

pub fn with_args(args: &[String]) -> Clier<MissingMeta, NotRunnable>

Creating a new Clier instance with custom arguments

Examples found in repository

examples/with_args.rs (line 9)

fn main() {
  let raw_args = args().collect::<Vec<String>>();
  let raw_args = &raw_args[1..];
  let args = Clier::with_args(raw_args);

  // Try changing 'String' to 'bool', or 'i64'
  let example_hook: Result<String, clier::hooks::FlagError> =
    use_flag("testing", Some('t'), &args).try_into();

  // Everything to the right of '--'
  let raw = use_double_dash(&args);

  println!("flag testing: {:#?}\neverything after '--': {:?}", example_hook, raw);
}

Trait Implementations

impl<T: Clone, R: Clone> Clone for Clier<T, R>

fn clone(&self) -> Clier<T, R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, R: Debug> Debug for Clier<T, R>

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

Formats the value using the given formatter.

impl<T: Default, R: Default> Default for Clier<T, R>

fn default() -> Clier<T, R>

Returns the “default value” for a type.