Struct CliArgs 

pub struct CliArgs {

    pub host: Option<String>,
    pub port: Option<u16>,
    pub color: bool,
    pub no_color: bool,
    pub browser: Option<String>,
    pub ssl: bool,
    pub no_file_io: bool,
    pub debug: bool,
    pub coverage: bool,
    pub execute: Option<String>,
    pub file: Option<String>,
    pub keyspace: Option<String>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub connect_timeout: Option<u64>,
    pub request_timeout: Option<u64>,
    pub tty: bool,
    pub encoding: Option<String>,
    pub cqlshrc: Option<String>,
    pub cqlversion: Option<String>,
    pub protocol_version: Option<u8>,
    pub consistency_level: Option<String>,
    pub serial_consistency_level: Option<String>,
    pub no_compact: bool,
    pub disable_history: bool,
    pub secure_connect_bundle: Option<String>,
    pub completions: Option<Shell>,
    pub generate_man: bool,
}

The Apache Cassandra interactive CQL shell (Rust implementation).

Connects to a Cassandra cluster and provides an interactive shell for executing CQL statements.

Fields

host: Option<String>

Contact point hostname (default: 127.0.0.1)

port: Option<u16>

Native transport port (default: 9042)

color: bool

Force colored output

no_color: bool

Disable colored output

browser: Option<String>

Browser for CQL HELP (unused in modern cqlsh)

ssl: bool

Enable SSL/TLS connection

no_file_io: bool

Disable file I/O commands (COPY, SOURCE, CAPTURE)

debug: bool

Show additional debug info

coverage: bool

Collect coverage (internal, accepted but ignored)

execute: Option<String>

Execute a CQL statement and exit

file: Option<String>

Execute statements from a file

keyspace: Option<String>

Default keyspace

username: Option<String>

Authentication username

password: Option<String>

Authentication password

connect_timeout: Option<u64>

Connection timeout in seconds

request_timeout: Option<u64>

Per-request timeout in seconds

tty: bool

Force TTY mode

encoding: Option<String>

Set character encoding (default: utf-8)

cqlshrc: Option<String>

Path to cqlshrc file (default: ~/.cassandra/cqlshrc)

cqlversion: Option<String>

CQL version to use

protocol_version: Option<u8>

Native protocol version

consistency_level: Option<String>

Initial consistency level

serial_consistency_level: Option<String>

Initial serial consistency level

no_compact: bool

Disable compact storage interpretation

disable_history: bool

Disable saving of command history

secure_connect_bundle: Option<String>

Secure connect bundle for Astra DB

completions: Option<Shell>

Generate shell completion script for the given shell (bash, zsh, fish, elvish, powershell)

generate_man: bool

Generate man page to stdout (hidden, used by release pipeline)

Implementations

impl CliArgs

pub fn validate(&self) -> Result<(), String>

Validate CLI arguments for mutual exclusivity and ranges.

Trait Implementations

impl Args for CliArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

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

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

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

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for CliArgs

fn clone(&self) -> CliArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for CliArgs

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for CliArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CliArgs

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

Instantiate Self from [ArgMatches], parsing the arguments as needed.

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

Instantiate Self from [ArgMatches], parsing the arguments as needed.

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

Assign values from ArgMatches to self.

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

Assign values from ArgMatches to self.

impl Parser for CliArgs

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.