Skip to main content

Commands

Enum Commands 

Source
pub enum Commands {
    SearchCrates {
        query: String,
        per_page: u32,
        sort: SortKind,
        page: u32,
        page_token: Option<String>,
    },
    Readme {
        crate_name: String,
        crate_version: Option<String>,
    },
    GetItem {
        crate_name: String,
        item_type: String,
        item_path: String,
        crate_version: Option<String>,
        suggest: bool,
    },
    SearchInCrate {
        crate_name: String,
        query: String,
        crate_version: Option<String>,
        item_type: Option<String>,
        limit: u32,
        match: String,
    },
    Version,
    Doctor {
        online: bool,
    },
    Commands,
    Schema {
        cmd: String,
    },
    Completions {
        shell: Shell,
    },
    Cache {
        action: CacheAction,
    },
    Config {
        action: ConfigAction,
    },
}
Expand description

Product subcommands exposed on the CLI surface.

Variants§

§

SearchCrates

Search crates on crates.io

Fields

§query: String

Search keywords (English). Optional when --page-token carries a full query string.

§per_page: u32

Results per page (max 100)

§sort: SortKind

Sort order

§page: u32

Page number (1-based). Conflicts with --page-token.

§page_token: Option<String>

Opaque pagination token from meta.next_page / meta.prev_page (full query or seek).

§

Readme

Fetch crate overview docblock from docs.rs (not git README)

Fields

§crate_name: String

Crate name on crates.io or a stdlib crate.

§crate_version: Option<String>

Optional crate version (latest when omitted).

§

GetItem

Fetch documentation for a typed item

Fields

§crate_name: String

Crate name on crates.io or a stdlib crate.

§item_type: String

Kind: module|struct|trait|enum|union|fn|function|method|type|const|constant|static|macro|attr|attribute|derive

§item_path: String

Path with :: or / (e.g. tokio::runtime::Runtime, runtime/Runtime, async_trait)

§crate_version: Option<String>

Optional crate version (latest when omitted).

§suggest: bool

On 404, suggest nearby symbols from all.html (extra request).

§

SearchInCrate

Search symbols in crate all.html index

Fields

§crate_name: String

Crate name on crates.io or a stdlib crate.

§query: String

Text filter; empty string lists all classified items

§crate_version: Option<String>

Optional crate version (latest when omitted).

§item_type: Option<String>

Optional item-kind filter (struct, fn, method, …).

§limit: u32

Maximum hits to emit (clamped to 1000).

§match: String

Match policy: exact | prefix (default) | substring

§

Version

Print binary version

§

Doctor

Validate local TLS/config readiness

Fields

§online: bool

Probe crates.io / docs.rs over the network (opt-in)

§

Commands

List the full command tree for agent discovery

§

Schema

Emit JSON Schema for a command

Fields

§cmd: String

Command name whose schema should be printed.

§

Completions

Generate shell completions

Fields

§shell: Shell

Target shell for completion scripts.

§

Cache

Inspect or clear the XDG HTTP disk cache

Fields

§action: CacheAction

Cache maintenance action.

§

Config

Manage XDG config paths and the optional config.toml (no secrets / no .env)

Fields

§action: ConfigAction

Config lifecycle action.

Trait Implementations§

Source§

impl Clone for Commands

Source§

fn clone(&self) -> Commands

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Commands

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for Commands

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for Commands

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more