Docs.rs
  • usage-lib-2.2.2
    • usage-lib 2.2.2
    • Permalink
    • Docs.rs crate page
    • MIT
    • Links
    • Homepage
    • Documentation
    • Repository
    • crates.io
    • Source
    • Owners
    • jdx
    • Dependencies
      • clap ^4 normal optional
      • heck ^0.5 normal
      • indexmap ^2 normal
      • itertools ^0.14 normal
      • kdl ^6 normal
      • log ^0.4 normal
      • miette ^7 normal
      • once_cell ^1 normal
      • regex ^1 normal
      • serde ^1 normal
      • shell-words ^1 normal
      • strum ^0.27 normal
      • tera ^1 normal optional
      • thiserror ^2 normal
      • versions ^7 normal
      • xx ^2 normal
      • ctor ^0.4 dev
      • insta ^1 dev
      • pretty_assertions ^1 dev
      • shell-words ^1 dev
    • Versions
    • 1.63% of the crate is documented
  • Platform
    • i686-pc-windows-msvc
    • i686-unknown-linux-gnu
    • x86_64-apple-darwin
    • x86_64-pc-windows-msvc
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Badges
    • Builds
    • Metadata
    • Shorthand URLs
    • Download
    • Rustdoc JSON
    • Build queue
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate usage

usage2.2.2

  • All Items

Crate Items

  • Re-exports
  • Modules
  • Macros

Crates

  • usage

Crate usage

Source

Re-exports§

pub use crate::parse::parse;
pub use crate::spec::arg::SpecArg;
pub use crate::spec::choices::SpecChoices;
pub use crate::spec::cmd::SpecCommand;
pub use crate::spec::complete::SpecComplete;
pub use crate::spec::flag::SpecFlag;
pub use crate::spec::mount::SpecMount;
pub use crate::spec::Spec;
pub use error::Result;

Modules§

complete
docs
error
parse
spec

Macros§

bail_parse

Results

Settings
Help
    re-export
    usage::SpecCommand
    struct field
    usage::spec::cmd::SpecCommand::args
    SpecCommand -> Vec
    struct field
    usage::spec::cmd::SpecCommand::help
    SpecCommand -> Option
    struct field
    usage::spec::cmd::SpecCommand::hide
    SpecCommand -> bool
    struct field
    usage::spec::cmd::SpecCommand::name
    SpecCommand -> String
    struct field
    usage::spec::cmd::SpecCommand::flags
    SpecCommand -> Vec
    struct field
    usage::spec::cmd::SpecCommand::usage
    SpecCommand -> String
    struct field
    usage::spec::cmd::SpecCommand::mounts
    SpecCommand -> Vec
    struct field
    usage::spec::cmd::SpecCommand::aliases
    SpecCommand -> Vec
    struct field
    usage::spec::cmd::SpecCommand::help_md
    SpecCommand -> Option
    struct field
    usage::spec::cmd::SpecCommand::complete
    SpecCommand -> IndexMap
    struct field
    usage::spec::cmd::SpecCommand::examples
    SpecCommand -> Vec
    struct field
    usage::spec::cmd::SpecCommand::full_cmd
    SpecCommand -> Vec
    struct field
    usage::spec::cmd::SpecCommand::help_long
    SpecCommand -> Option
    struct field
    usage::spec::cmd::SpecCommand::after_help
    SpecCommand -> Option
    struct field
    usage::spec::cmd::SpecCommand::deprecated
    SpecCommand -> Option
    struct field
    usage::spec::cmd::SpecCommand::before_help
    SpecCommand -> Option
    struct field
    usage::spec::cmd::SpecCommand::subcommands
    SpecCommand -> IndexMap
    struct field
    usage::spec::cmd::SpecCommand::after_help_md
    SpecCommand -> Option
    struct field
    usage::spec::cmd::SpecCommand::before_help_md
    SpecCommand -> Option
    struct field
    usage::spec::cmd::SpecCommand::hidden_aliases
    SpecCommand -> Vec
    struct field
    usage::spec::cmd::SpecCommand::after_help_long
    SpecCommand -> Option
    struct field
    usage::spec::cmd::SpecCommand::before_help_long
    SpecCommand -> Option
    struct field
    usage::spec::cmd::SpecCommand::subcommand_required
    SpecCommand -> bool
    method
    usage::spec::cmd::SpecCommand::clone
    &SpecCommand -> SpecCommand
    method
    usage::spec::cmd::SpecCommand::usage
    &SpecCommand -> String
    method
    usage::spec::cmd::SpecCommand::serialize
    &SpecCommand, __S -> Result
    method
    usage::spec::cmd::SpecCommand::all_subcommands
    &SpecCommand -> Vec<&SpecCommand>
    method
    usage::spec::cmd::SpecCommand::fmt
    &SpecCommand, &mut Formatter -> Result
    function
    usage::docs::cli::render_help
    &Spec, &SpecCommand, bool -> String
    method
    usage::docs::markdown::MarkdownRenderer::render_cmd
    &MarkdownRenderer, &SpecCommand -> Result<String, UsageErr>
    method
    usage::spec::cmd::SpecCommand::find_subcommand
    &SpecCommand, &str -> Option<&SpecCommand>
    method
    usage::spec::cmd::SpecCommand::default
    -> SpecCommand
    struct field
    usage::parse::ParseOutput::cmd
    ParseOutput -> SpecCommand
    struct field
    usage::spec::Spec::cmd
    Spec -> SpecCommand
    method
    usage::spec::cmd::SpecCommand::clone
    &SpecCommand -> SpecCommand
    method
    usage::spec::cmd::SpecCommand::find_subcommand
    &SpecCommand, &str -> Option<&SpecCommand>