Struct rerun::clap::RerunArgs

pub struct RerunArgs {
    spawn: bool,
    save: Option<PathBuf>,
    stdout: bool,
    connect: Option<Option<SocketAddr>>,
    serve: bool,
    server_memory_limit: String,
    bind: String,
}

This struct implements a clap::Parser that defines all the arguments that a typical Rerun application might use, and provides helpers to evaluate those arguments and behave consequently.

Integrate it into your own clap::Parser by flattening it:

#[derive(Debug, clap::Parser)]
#[clap(author, version, about)]
struct MyArgs {
    #[command(flatten)]
    rerun: rerun::clap::RerunArgs,

    #[clap(long)]
    my_arg: bool,
}

Checkout the official examples to see it used in practice.

Fields

spawn: bool

Start a new Rerun Viewer process and feed it data in real-time.

save: Option<PathBuf>

Saves the data to an rrd file rather than visualizing it immediately.

stdout: bool

Log data to standard output, to be piped into a Rerun Viewer.

connect: Option<Option<SocketAddr>>

Connects and sends the logged data to a remote Rerun viewer.

Optionally takes an ip:port.

serve: bool

Connects and sends the logged data to a web-based Rerun viewer.

server_memory_limit: String

An upper limit on how much memory the WebSocket server should use.

The server buffers log messages for the benefit of late-arriving viewers.

When this limit is reached, Rerun will drop the oldest data. Example: 16GB or 50% (of system total).

Defaults to 25%.

bind: String

What bind address IP to use.

Implementations

impl RerunArgs

pub fn init( &self, application_id: &str ) -> Result<(RecordingStream, ServeGuard)>

Creates a new RecordingStream according to the CLI parameters.

fn to_behavior(&self) -> Result<RerunBehavior>

Trait Implementations

impl Args for RerunArgs

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 RerunArgs

fn clone(&self) -> RerunArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RerunArgs

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

Formats the value using the given formatter.

impl FromArgMatches for RerunArgs

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.