Struct ToolArgs 

pub struct ToolArgs {
    pub(crate) port: Option<String>,
    pub(crate) ble: Option<Option<String>>,
    pub(crate) tcp: Option<String>,
    pub(crate) pick: bool,
    pub(crate) baud: u32,
    pub(crate) trace: bool,
    pub(crate) no_save: bool,
    pub(crate) node: Option<KeyArg>,
    pub(crate) color: ColorChoice,
    pub(crate) command: Option<Command>,
}

Fields

port: Option<String>

Serial port to attach to.

ble: Option<Option<String>>

Attach over BLE, optionally naming the radio by name or scan id.

The selector needs the = form (--ble=T-Echo); bare --ble discovers.

tcp: Option<String>

Attach to a radio served over TCP, as HOST:PORT.

The socket carries the same framing a serial port does, so anything bridging one to a listening socket serves a radio this way:

socat TCP-LISTEN:9000,reuseaddr /dev/cu.usbmodem101,raw,echo=0,b115200

pick: bool

Choose the radio from a numbered listing, ignoring the saved default.

The listing appears on its own whenever the answer is ambiguous; this asks for it even when it is not.

baud: u32

Serial bit rate.

trace: bool

Print every ULCP frame on stderr.

no_save: bool

Leave mutations live-only. They otherwise persist automatically via CMD_SAVE.

node: Option<KeyArg>

Reach a device across the mesh, using the attached radio to get there.

The command-line form of the shell’s remote: attach a radio as usual, then borrow it to open a session to KEY. With a command, that command runs over the mesh and the radio is handed back; with no command, the shell opens already talking to KEY. The device must list this tool’s administrator key (admin-key prints it).

color: ColorChoice

When to colorize output.

command: Option<Command>

Implementations

impl ToolArgs

pub(crate) fn discovery(&self) -> Discovery

Trait Implementations

impl Args for ToolArgs

fn group_id() -> Option<Id>

Report the 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 CommandFactory for ToolArgs

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 ToolArgs

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

Formats the value using the given formatter.

impl FromArgMatches for ToolArgs

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 ToolArgs

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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.