Struct RestoreArgs 

pub struct RestoreArgs {

    pub archive: ArchiveArgs,
    pub worm_expect_head: Vec<String>,
    pub target: TargetArgs,
    pub topic: Vec<String>,
    pub to_offset: Vec<OffsetBound>,
    pub to_timestamp: Option<i64>,
    pub exclude_key: Vec<Regex>,
    pub exclude_header: Vec<HeaderPattern>,
    pub exclude_producer_id: Vec<ProducerId>,
    pub exclude_offset: Vec<OffsetRange>,
    pub dry_run: bool,
    pub report: ReportFormat,
    pub continue_on_corrupt: bool,
}

Arguments of an offline point-in-time restore.

The fields are public so a test or an embedding tool can build the struct directly. A clap::Args struct with private fields is reachable only through an argv, which forces every caller through string formatting.

Fields

archive: ArchiveArgs

Where the archive is.

worm_expect_head: Vec<String>

Independently pinned WORM chain head, PARTITION_DIR=64_HEX.

target: TargetArgs

The cluster the restore writes.

topic: Vec<String>

Restore this topic. May be repeated. Every topic the archive holds is restored when the flag is absent.

to_offset: Vec<OffsetBound>

Keep offsets at or below N in one partition: topic:partition=N. May be repeated.

to_timestamp: Option<i64>

Keep records whose timestamp is below this instant. Accepts RFC 3339 with an explicit zone, or bare epoch milliseconds.

exclude_key: Vec<Regex>

Drop records whose key matches this pattern. May be repeated.

exclude_header: Vec<HeaderPattern>

Drop records that carry a header matching NAME=REGEX. May be repeated.

exclude_producer_id: Vec<ProducerId>

Drop records written by this producer id. May be repeated.

exclude_offset: Vec<OffsetRange>

Drop an offset range in one partition: topic:partition=A..B, with B exclusive. Write A..=B to include B. May be repeated.

dry_run: bool

Verify, check the format, and report without writing to –log-dir.

report: ReportFormat

Report format.

continue_on_corrupt: bool

Skip a segment that fails verification instead of stopping. The report names every segment that was skipped.

Implementations

impl RestoreArgs

pub fn validate(&self) -> Result<(), RestoreError>

Check the flag combinations clap cannot express.

Errors

Returns RestoreError::InvalidArgument when a backend sub-flag names a backend that --archive-* did not select, when one partition carries two --to-offset bounds, or when a bound names a topic that --topic excludes. Each means the operator wrote a flag that can never apply.

impl RestoreArgs

pub fn selects_topic(&self, topic: &str) -> bool

Whether topic is in the restore set.

An empty --topic list selects every topic the archive holds.

Trait Implementations

impl Args for RestoreArgs

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

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

Formats the value using the given formatter.

impl FromArgMatches for RestoreArgs

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.