Skip to main content

Command

Enum Command 

Source
pub enum Command {
    Tui,
    Init(InitArgs),
    Profile {
        command: ProfileCommand,
    },
    Config {
        command: ConfigCommand,
    },
    Notebooks {
        command: Notebooks,
    },
    Sections {
        command: Sections,
    },
    Pages {
        command: Pages,
    },
    Search {
        query: String,
        scope: Option<String>,
        scan: bool,
        scan_limit: Option<u16>,
        scan_offset: Option<u32>,
        page: PageArgs,
    },
    Doctor {
        offline: bool,
    },
    Capabilities,
    Schema {
        command: Option<String>,
    },
    Completions {
        shell: Shell,
    },
}

Variants§

§

Tui

Explore notebooks, sections, and pages in an interactive terminal

§

Init(InitArgs)

Configure and check a local desktop or SSH connection

§

Profile

List, select, or remove saved connection profiles

Fields

§

Config

Inspect connection settings and their storage location

Fields

§

Notebooks

List notebooks open in the desktop application

Fields

§command: Notebooks
§

Sections

Explore sections, including those inside section groups

Fields

§command: Sections
§

Pages

Read, create, and append to pages

Fields

§command: Pages
§

Search

Search pages with OneNote’s index or a literal text scan

Fields

§query: String
§scope: Option<String>

Limit search to a notebook, section group, or section ID

§scan: bool

Read page titles and text directly; case-insensitive literal matching

§scan_limit: Option<u16>

Maximum pages to attempt per scan (default 100, maximum 500)

§scan_offset: Option<u32>

Continue from next_scan_offset; independent of result –offset

§

Doctor

Check the selected connection and OneNote access

Fields

§offline: bool

Check configuration and local transport availability without connecting

§

Capabilities

Describe supported capabilities and requirements

§

Schema

Emit the offline CLI Spec v0.3 contract

Fields

§command: Option<String>
§

Completions

Generate shell completions

Fields

§shell: Shell

Trait Implementations§

Source§

impl Debug for Command

Source§

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

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

impl FromArgMatches for Command

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 Command

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.