Skip to main content

run_from_args_with_records

Function run_from_args_with_records 

Source
pub async fn run_from_args_with_records<I, T>(
    argv: I,
    extra: Vec<MetadataRecord>,
) -> i32
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,
Expand description

Run the formatter from an argv-style iterator, seeding extra alongside the records the flags produce, and return its exit code.

This is the entry point for a tool that materializes a cluster and then has to hand the formatter the metadata it recovered, such as the topic and partition records behind a point-in-time restore. FormatArgs holds private fields, so an argv is how such a caller states the rest of the format; run_with_records documents where extra lands in the seed stream.

Malformed arguments print a diagnostic and return 2. Help and version requests print to stdout and return 0, without terminating the caller.