pub struct Cli {Show 26 fields
pub json: bool,
pub format: Option<OutputFormat>,
pub timeout: Option<u64>,
pub connect_timeout: Option<u64>,
pub user_agent: Option<String>,
pub lang: Option<String>,
pub config_dir: Option<PathBuf>,
pub cache_dir: Option<PathBuf>,
pub no_cache: bool,
pub cache_ttl_secs: Option<u64>,
pub max_cache_bytes: Option<u64>,
pub dry_run: bool,
pub max_body_bytes: Option<u64>,
pub agent: AgentArgs,
pub rate_limit_delay_ms: Option<u64>,
pub max_concurrency: Option<u32>,
pub max_retries: Option<u32>,
pub retry_base_ms: Option<u64>,
pub retry_max_delay_ms: Option<u64>,
pub retry_max_elapsed_ms: Option<u64>,
pub disable_retry: bool,
pub allow_loopback: bool,
pub verbose: u8,
pub quiet: bool,
pub no_color: bool,
pub command: Commands,
}Expand description
Top-level clap parser for the docsrs-cli binary.
Fields§
§json: boolEmit JSON envelope on stdout
format: Option<OutputFormat>Output format (json is alias of –json)
timeout: Option<u64>Wall-clock timeout in seconds (must be >= 1 when set)
connect_timeout: Option<u64>Connect timeout in seconds (must be >= 1 when set)
user_agent: Option<String>Override User-Agent
lang: Option<String>Force human stderr locale: en or pt-BR (fail-closed; JSON stays English)
config_dir: Option<PathBuf>Override XDG config directory
cache_dir: Option<PathBuf>Override XDG cache directory for HTTP body cache
no_cache: boolDisable disk cache (always hit network)
cache_ttl_secs: Option<u64>Disk cache TTL in seconds (default 86400 = 24h)
max_cache_bytes: Option<u64>Soft cap on disk cache size in bytes (default 268435456 = 256 MiB; 0 = unlimited)
dry_run: boolPlan URLs without opening network sockets
max_body_bytes: Option<u64>Cap downloaded body size in bytes (hard max 10485760 = 10 MiB; cannot raise above)
agent: AgentArgsAgent-native payload reduction knobs (see AgentArgs).
rate_limit_delay_ms: Option<u64>Minimum delay between requests to the same host (ms)
max_concurrency: Option<u32>Max concurrent CPU parse workers (0 = auto from CPUs and free RAM)
max_retries: Option<u32>Max HTTP retries for transient errors (after the first attempt)
retry_base_ms: Option<u64>Base backoff delay in milliseconds for HTTP retries
retry_max_delay_ms: Option<u64>Maximum single HTTP retry sleep in milliseconds
retry_max_elapsed_ms: Option<u64>Total HTTP retry wall budget in milliseconds (0 = derive from –timeout)
disable_retry: boolDisable HTTP retries (incident kill switch / debug)
allow_loopback: boolAllow loopback origins (127.0.0.1 / localhost) for offline wiremock
Also settable via XDG config.toml allow_loopback = true. Never via env.
verbose: u8Increase stderr verbosity
quiet: boolSuppress non-error stderr prose
no_color: boolDisable ANSI colors on stderr
command: CommandsSubcommand to execute for this invocation.
Implementations§
Source§impl Cli
impl Cli
Sourcepub fn wire_command(&self) -> &'static str
pub fn wire_command(&self) -> &'static str
Wire command name for the active subcommand (error/success envelopes).
Sourcepub fn wants_json(&self, stdout_is_terminal: bool) -> bool
pub fn wants_json(&self, stdout_is_terminal: bool) -> bool
Whether JSON envelope is requested.
Agent-first rules (stdin/stdout LLM contract):
--jsonor--format json→ JSON--format markdown|text→ human (never auto-JSON)- otherwise → JSON when stdout is not a TTY (pipe/agent), markdown on TTY
Sourcepub fn validate_format_conflict(&self) -> Result<(), AppError>
pub fn validate_format_conflict(&self) -> Result<(), AppError>
Reject incompatible --json + --format text|markdown.
§Errors
Returns crate::error::ErrorKind::Usage when --json is combined with
--format text or --format markdown.
Trait Implementations§
Source§impl Args for Cli
impl Args for Cli
Source§fn augment_args<'b>(__clap_app: Command) -> Command
fn augment_args<'b>(__clap_app: Command) -> Command
Source§fn augment_args_for_update<'b>(__clap_app: Command) -> Command
fn augment_args_for_update<'b>(__clap_app: Command) -> Command
Command so it can instantiate self via
FromArgMatches::update_from_arg_matches_mut Read moreSource§impl CommandFactory for Cli
impl CommandFactory for Cli
Source§impl FromArgMatches for Cli
impl FromArgMatches for Cli
Source§fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
Source§fn from_arg_matches_mut(
__clap_arg_matches: &mut ArgMatches,
) -> Result<Self, Error>
fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>
Source§fn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches,
) -> Result<(), Error>
fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>
ArgMatches to self.Source§fn update_from_arg_matches_mut(
&mut self,
__clap_arg_matches: &mut ArgMatches,
) -> Result<(), Error>
fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>
ArgMatches to self.