Struct HeartbeatOpts 

pub struct HeartbeatOpts {
    pub heartbeat: Option<f64>,
    pub heartbeat_emit: Option<String>,
    pub heartbeat_to: PulseTo,
}

The shared --heartbeat option group, #[command(flatten)]-ed into every leaf tool’s CLI so the flags are named and documented identically.

Fields

heartbeat: Option<f64>

Print a liveness pulse every SECS seconds (fractional allowed) while the run is in progress.

heartbeat_emit: Option<String>

Heartbeat line template. Tokens: {ELAPSED} (whole seconds so far), {TOOL}, plus per-tool tokens. Default: “[{ELAPSED}s]”.

heartbeat_to: PulseTo

Stream heartbeat pulses are written to.

Implementations

impl HeartbeatOpts

pub fn start( &self, tool: &str, state: Arc<PulseState>, ) -> Result<Option<Heartbeat>, String>

Start the pulse if --heartbeat was given. state carries the dynamic tokens; the {TOOL} token is set here. Returns the guard that stops the pulse on drop (None when no heartbeat was requested).

Trait Implementations

impl Args for HeartbeatOpts

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 HeartbeatOpts

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

Formats the value using the given formatter.

impl FromArgMatches for HeartbeatOpts

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.