mirror of
https://github.com/clap-rs/clap
synced 2024-12-13 14:22:34 +00:00
123 lines
3.9 KiB
Rust
123 lines
3.9 KiB
Rust
// Copyright ⓒ 2015-2016 Kevin B. Knapp and [`clap-rs` contributors](https://github.com/clap-rs/clap/graphs/contributors).
|
|
// Licensed under the MIT license
|
|
// (see LICENSE or <http://opensource.org/licenses/MIT>) All files in the project carrying such
|
|
// notice may not be copied, modified, or distributed except according to those terms.
|
|
|
|
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
|
#![doc(html_logo_url = "https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png")]
|
|
#![cfg_attr(feature = "derive", doc = include_str!("../README.md"))]
|
|
//! <https://github.com/clap-rs/clap>
|
|
#![warn(
|
|
missing_docs,
|
|
missing_debug_implementations,
|
|
missing_copy_implementations,
|
|
trivial_casts,
|
|
unused_allocation,
|
|
trivial_numeric_casts,
|
|
clippy::single_char_pattern
|
|
)]
|
|
#![forbid(unsafe_code)]
|
|
// HACK https://github.com/rust-lang/rust-clippy/issues/7290
|
|
#![allow(clippy::single_component_path_imports)]
|
|
#![allow(clippy::branches_sharing_code)]
|
|
// Doesn't allow for debug statements, etc to be unique
|
|
#![allow(clippy::if_same_then_else)]
|
|
|
|
#[cfg(not(feature = "std"))]
|
|
compile_error!("`std` feature is currently required to build `clap`");
|
|
|
|
pub use crate::builder::Command;
|
|
pub use crate::builder::{Arg, ArgGroup};
|
|
pub use crate::error::Error;
|
|
pub use crate::parser::ArgMatches;
|
|
#[cfg(feature = "color")]
|
|
pub use crate::util::color::ColorChoice;
|
|
#[cfg(not(feature = "color"))]
|
|
#[allow(unused_imports)]
|
|
pub(crate) use crate::util::color::ColorChoice;
|
|
|
|
pub use crate::derive::{ArgEnum, Args, CommandFactory, FromArgMatches, Parser, Subcommand};
|
|
|
|
#[allow(deprecated)]
|
|
pub use crate::builder::App;
|
|
pub use crate::builder::{AppFlags, AppSettings, ArgFlags, ArgSettings, PossibleValue, ValueHint};
|
|
pub use crate::error::{ErrorKind, Result};
|
|
pub use crate::parser::{Indices, OsValues, ValueSource, Values};
|
|
|
|
#[cfg(feature = "yaml")]
|
|
#[doc(hidden)]
|
|
#[deprecated(
|
|
since = "3.0.0",
|
|
note = "Deprecated in Issue #3087, maybe clap::Parser would fit your use case?"
|
|
)]
|
|
#[doc(hidden)]
|
|
pub use yaml_rust::YamlLoader;
|
|
|
|
#[cfg(feature = "derive")]
|
|
#[doc(hidden)]
|
|
pub use clap_derive::{self, *};
|
|
|
|
/// Deprecated, replaced with [`CommandFactory`]
|
|
#[deprecated(since = "3.0.0", note = "Replaced with `CommandFactory`")]
|
|
pub use CommandFactory as IntoApp;
|
|
/// Deprecated, replaced with [`Parser`]
|
|
#[deprecated(since = "3.0.0", note = "Replaced with `Parser`")]
|
|
#[doc(hidden)]
|
|
pub use Parser as StructOpt;
|
|
|
|
#[cfg(any(feature = "derive", feature = "cargo"))]
|
|
#[doc(hidden)]
|
|
pub use lazy_static;
|
|
|
|
#[macro_use]
|
|
#[allow(missing_docs)]
|
|
mod macros;
|
|
|
|
mod derive;
|
|
|
|
#[cfg(feature = "regex")]
|
|
pub use crate::builder::RegexRef;
|
|
|
|
pub mod builder;
|
|
pub mod error;
|
|
pub mod parser;
|
|
|
|
mod mkeymap;
|
|
mod output;
|
|
mod util;
|
|
|
|
const INTERNAL_ERROR_MSG: &str = "Fatal internal error. Please consider filing a bug \
|
|
report at https://github.com/clap-rs/clap/issues";
|
|
const INVALID_UTF8: &str = "unexpected invalid UTF-8 code point";
|
|
|
|
/// Deprecated, replaced with [`Command::new`], unless you were looking for [Subcommand]
|
|
#[deprecated(
|
|
since = "3.0.0",
|
|
note = "Replaced with `Command::new` unless you intended the `Subcommand` trait"
|
|
)]
|
|
#[doc(hidden)]
|
|
#[derive(Debug, Copy, Clone)]
|
|
pub struct SubCommand {}
|
|
|
|
#[allow(deprecated)]
|
|
impl SubCommand {
|
|
/// Deprecated, replaced with [`Command::new`].
|
|
/// Did you mean Subcommand (lower-case c)?
|
|
#[deprecated(since = "3.0.0", note = "Replaced with `Command::new`")]
|
|
#[doc(hidden)]
|
|
pub fn with_name<'help>(name: &str) -> App<'help> {
|
|
Command::new(name)
|
|
}
|
|
|
|
/// Deprecated in [Issue #3087](https://github.com/clap-rs/clap/issues/3087), maybe [`clap::Parser`][crate::Parser] would fit your use case?
|
|
#[cfg(feature = "yaml")]
|
|
#[deprecated(
|
|
since = "3.0.0",
|
|
note = "Deprecated in Issue #3087, maybe clap::Parser would fit your use case?"
|
|
)]
|
|
#[doc(hidden)]
|
|
pub fn from_yaml(yaml: &yaml_rust::Yaml) -> App {
|
|
#![allow(deprecated)]
|
|
Command::from_yaml(yaml)
|
|
}
|
|
}
|