Struct PingArgs 

pub struct PingArgs {

    pub target: KeyArg,
    pub count: u32,
    pub interval: u64,
    pub timeout: u64,
    pub size: u16,
    pub hops: Option<u8>,
    pub flood: bool,
    pub route: Option<RouteArg>,
    pub channel: Option<ChannelArg>,
    pub ack_only: bool,
    pub mic: MicArg,
    pub region: Option<RegionCodeArg>,
    pub full_source: bool,
    pub salt: bool,
    pub untraced: bool,
}

Fields

target: KeyArg

The node to ping, as its node public key.

count: u32

How many pings to send.

interval: u64

Seconds to wait between one ping and the next.

timeout: u64

Seconds to wait for each reply.

size: u16

Bytes of echo data, including the 2-byte nonce. The frame’s own budget is the real ceiling, and an oversize ping is refused rather than shortened.

hops: Option<u8>

Flood-hop ceiling. 0 sends without a flood budget at all.

flood: bool

Flood even where a route to the target is already cached.

route: Option<RouteArg>

Steer the ping down an explicit route: a comma-separated list of hops, first hop first, each four hex digits of a router hint or a full node key.

channel: Option<ChannelArg>

Ping inside a channel, as a blind unicast—a channel name, or the 32 bytes of a private channel key. A target that has never been heard from cannot resolve a 3-byte source hint, so first contact on a channel wants --full-source.

ack_only: bool

Send a No-op MAC command asking for an acknowledgment, and time the ack instead of an echo. Measures the MAC’s own round trip, with no application frame coming back.

mic: MicArg

MIC size in bytes.

region: Option<RegionCodeArg>

Stamp the ping with a region code.

full_source: bool

Carry the whole 32-byte source key rather than a 3-byte hint.

salt: bool

Randomize the SECINFO salt.

untraced: bool

Leave off the trace-route and trace-signal options, which are otherwise on: without them a reply that crossed repeaters names none of them and carries no per-hop signal. The RSSI and SNR on each line are this radio’s own measurement of the reply and are unaffected. Unrelated to the global --trace, which prints frames on stderr.

Implementations

impl PingArgs

fn send_options(&self) -> Result<SendOptions>

The frame shape these flags ask for.

Trait Implementations

impl Args for PingArgs

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 Debug for PingArgs

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

Formats the value using the given formatter.

impl FromArgMatches for PingArgs

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.