Struct Predicates 

pub struct Predicates { /* private fields */ }

The compiled predicate set.

Implementations

impl Predicates

pub fn from_args(args: &RestoreArgs) -> Result<Self, RestoreError>

Compile the bound flags into a predicate set.

Errors

Returns RestoreError::InvalidArgument when a partition’s --exclude-offset ranges, merged, cover every offset from 0 through that partition’s --to-offset bound: nothing between 0 and the bound can survive, so the bound keeps zero records for that partition. That is the one flag combination this function can prove empties a partition without reading the archive, because both windows are named entirely by the flags. Two related cases are deliberately not flagged here. A negative --to-offset, which would exclude a whole partition outright, is already rejected by RestoreArgs’s own parser and never reaches this function. A --exclude-key or --exclude-header pattern that matches every possible byte string, such as an empty pattern or .*, is not detected either: proving a regex is universal is not a check this function attempts, a partial heuristic would catch some universal patterns and not others, and unlike an offset window, a key predicate never empties a partition on its own anyway, because a keyless record still survives it.

impl Predicates

pub fn offset_bound(&self, partition: &PartitionRef) -> Option<Offset>

The highest offset the restore keeps in partition, when --to-offset names it.

--to-timestamp gives no equivalent lookup here, because it is a global bound that applies to every partition alike, while --to-offset is named per partition. Turning a timestamp bound into an offset a caller could look up the same way would need a batch’s own timestamp, and the only place that reads one is Self::decide_batch; there is no offset this method can hand back for a timestamp bound without decoding a batch first.

pub fn batch_past_offset_bound( &self, partition: &PartitionRef, batch_base: Offset, ) -> bool

Whether this batch and every later ordered batch start past the partition’s inclusive offset bound.

pub fn decide_batch( &self, partition: &PartitionRef, batch: &RecordBatchBorrowed<'_>, ) -> Result<BatchDecision, RestoreError>

Decide the fate of one archived batch.

The caller applies Self::batch_past_offset_bound first and stops walking the partition once a batch’s base offset is past it. A batch that straddles the inclusive offset bound is still decoded here so only its records at or below the bound survive.

Errors

While evaluating an applicable record predicate, returns an integrity error if a record fails to parse, lies outside the batch’s declared offset range, or its absolute offset or timestamp cannot be represented.

pub fn decide_record( &self, partition: &PartitionRef, offset: Offset, timestamp_ms: i64, producer_id: ProducerId, record: &RecordBorrowed<'_>, ) -> RecordDecision

Decide the fate of one record inside a batch that must be re-encoded.

The record is dropped when any predicate matches, OR-combined: its absolute offset falls in an --exclude-offset range for partition, producer_id is named by --exclude-producer-id, record.key matches an --exclude-key pattern, or one of record’s headers matches an --exclude-header NAME=REGEX pattern by name and value. A record is also dropped when it is above the partition’s inclusive --to-offset bound or at or after the global exclusive --to-timestamp bound. A record with key: None never matches a key pattern, and a header whose value is absent never matches a header pattern; neither is treated as matching an empty string.

--exclude-key and --exclude-header match the raw bytes only when those bytes are valid UTF-8. regex::Regex::is_match takes &str, and a byte string an operator’s regex cannot even be checked against must not silently match it merely because it fails to decode, so invalid UTF-8 never matches.

Trait Implementations

impl Debug for Predicates

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

Formats the value using the given formatter.