1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
use super::{GetWithDefault, LogLevel};
use log::{Level, LevelFilter};
use std::fmt;
/// This struct provides the `--verbose` cli option
///
/// By default, the log level is set to error.
/// Multiple occurrences, will increase the verbosity level up to 4.
///
/// ```rust
/// extern crate structopt_flags;
/// #[macro_use]
/// extern crate structopt;
///
/// use structopt::StructOpt;
/// use structopt_flags::LogLevel; // to access get_log_level
///
/// #[derive(Debug, StructOpt)]
/// #[structopt(name = "verbose", about = "An example using verbose flag")]
/// struct Opt {
/// #[structopt(flatten)]
/// verbose: structopt_flags::Verbose,
/// }
///
/// fn main() {
/// let opt = Opt::from_args();
/// let filter_level = opt.verbose.get_level_filter();
/// // set log level
/// }
/// ```
#[derive(StructOpt, Debug, Clone)]
pub struct Verbose {
/// Increase the output's verbosity level (default:info)
/// Pass many times to increase verbosity level, up to 4.
#[structopt(
name = "verbose",
long = "verbose",
short = "v",
parse(from_occurrences),
raw(global = "true")
)]
verbosity_level: u8,
}
impl LogLevel for Verbose {
fn get_level_filter(&self) -> LevelFilter {
match self.verbosity_level {
0 => LevelFilter::Error,
1 => LevelFilter::Warn,
2 => LevelFilter::Info,
3 => LevelFilter::Debug,
_ => LevelFilter::Trace,
}
}
fn get_log_level(&self) -> Option<Level> {
self.get_level_filter().to_level()
}
}
impl fmt::Display for Verbose {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", self.get_level_filter())
}
}
/// This struct provides the `--verbose` cli option, without a predefined default
///
/// Multiple occurrences, will increase the verbosity level
///
/// ```rust
/// extern crate log;
/// extern crate structopt_flags;
/// #[macro_use]
/// extern crate structopt;
///
/// use log::LevelFilter;
/// use structopt::StructOpt;
/// use structopt_flags::GetWithDefault; // to access get_log_level
///
/// #[derive(Debug, StructOpt)]
/// #[structopt( name = "verbose_no_def", about = "An example using verbose flag with no predefined default")]
/// struct Opt {
/// #[structopt(flatten)]
/// verbose: structopt_flags::VerboseNoDef,
/// }
///
/// fn main() {
/// let opt = Opt::from_args();
/// let filter_level = opt.verbose.get_with_default(LevelFilter::Off);
/// // set log level
/// }
/// ```
#[derive(StructOpt, Debug, Clone)]
pub struct VerboseNoDef {
/// Increase the output's verbosity level
/// Pass many times to increase verbosity level.
#[structopt(
name = "verbose",
long = "verbose",
short = "v",
parse(from_occurrences),
raw(global = "true")
)]
verbosity_level: u8,
}
impl GetWithDefault for VerboseNoDef {
type Item = LevelFilter;
fn get_with_default(&self, default: Self::Item) -> Self::Item {
let default_value: i8 = match default {
LevelFilter::Off => -1,
LevelFilter::Error => 0,
LevelFilter::Warn => 1,
LevelFilter::Info => 2,
LevelFilter::Debug => 3,
LevelFilter::Trace => 4,
};
match default_value + self.verbosity_level as i8 {
-1 => LevelFilter::Off,
0 => LevelFilter::Error,
1 => LevelFilter::Warn,
2 => LevelFilter::Info,
3 => LevelFilter::Debug,
_ => LevelFilter::Trace,
}
}
}
/// This struct implements the `--verbose` and the `--quiet` cli options
///
/// By default, the log level is set to warning.
/// Multiple occurrences of `-v`, will increase the verbosity level up to 3.
/// The flag `-q` is used to decrease verbosity.
/// Using it twice, will silent the log.
///
/// ```rust
/// extern crate structopt_flags;
/// #[macro_use]
/// extern crate structopt;
///
/// use structopt::StructOpt;
/// use structopt_flags::LogLevel; // to access get_log_level
///
/// #[derive(Debug, StructOpt)]
/// #[structopt(name = "verbose", about = "An example using verbose flag")]
/// struct Opt {
/// #[structopt(flatten)]
/// verbose: structopt_flags::Verbose,
/// }
///
/// fn main() {
/// let opt = Opt::from_args();
/// let filter_level = opt.verbose.get_level_filter();
/// // set log level
/// }
/// ```
#[derive(StructOpt, Debug, Clone)]
pub struct QuietVerbose {
/// Increase the output's verbosity level
/// Pass many times to increase verbosity level, up to 3.
#[structopt(
name = "quietverbose",
long = "verbose",
short = "v",
parse(from_occurrences),
conflicts_with = "quietquiet",
raw(global = "true")
)]
verbosity_level: u8,
/// Decrease the output's verbosity level
/// Used once, it will set error log level.
/// Used twice, will slient te log completely
#[structopt(
name = "quietquiet",
long = "quiet",
short = "q",
parse(from_occurrences),
conflicts_with = "quietverbose",
raw(global = "true")
)]
quiet_level: u8,
}
impl LogLevel for QuietVerbose {
fn get_level_filter(&self) -> LevelFilter {
let quiet: i8 = if self.quiet_level > 1 {
2
} else {
self.quiet_level as i8
};
let verbose: i8 = if self.verbosity_level > 2 {
3
} else {
self.verbosity_level as i8
};
match verbose - quiet {
-2 => LevelFilter::Off,
-1 => LevelFilter::Error,
0 => LevelFilter::Warn,
1 => LevelFilter::Info,
2 => LevelFilter::Debug,
_ => LevelFilter::Trace,
}
}
fn get_log_level(&self) -> Option<Level> {
self.get_level_filter().to_level()
}
}
impl fmt::Display for QuietVerbose {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", self.get_level_filter())
}
}
/// This struct implements the `--verbose` cli option as a boolean flag
///
/// By default, the log level is set to warning.
/// Multiple occurrences of `-v` are not supported
///
/// ```rust
/// extern crate structopt_flags;
/// #[macro_use]
/// extern crate structopt;
///
/// use structopt::StructOpt;
///
/// #[derive(Debug, StructOpt)]
/// #[structopt(name = "verbose", about = "An example using verbose flag")]
/// struct Opt {
/// #[structopt(flatten)]
/// verbose: structopt_flags::SimpleVerbose,
/// }
///
/// fn main() {
/// let opt = Opt::from_args();
/// if opt.verbose.verbose {
/// println!("Verbose output enabled");
/// } else {
/// println!("No verbose output");
/// }
/// }
/// ```
#[derive(StructOpt, Debug, Clone)]
pub struct SimpleVerbose {
/// Enable the verbose output
/// No multiple occurrences are supported
#[structopt(
name = "simpleverbose",
long = "verbose",
short = "v",
raw(global = "true")
)]
pub verbose: bool,
}
impl fmt::Display for SimpleVerbose {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if self.verbose {
write!(f, "True")
} else {
write!(f, "False")
}
}
}