Struct tidb_query_common::storage::ranges_iter::RangesIterator

[+] Show declaration

pub struct RangesIterator {
    in_range: bool,
    iter: IntoIter<Range>,
}

[−] Expand description

An iterator like structure that produces user key ranges.

For each next(), it produces one of the following:

• a new range
• a flag indicating continuing last interval range
• a flag indicating that all ranges are consumed

If a new range is returned, caller can then scan unknown amount of key(s) within this new range. The caller must inform the structure so that it will emit a new range next time by calling notify_drained() after current range is drained. Multiple notify_drained() without next() will have no effect.

Fields

in_range: bool

[−] Expand description

Whether or not we are processing a valid range. If we are not processing a range, or there is no range any more, this field is false.

iter: IntoIter<Range>

Implementations

impl RangesIterator[−]

pub fn new(user_key_ranges: Vec<Range>) -> Self

pub fn next(&mut self) -> IterStatus[−]

Continues iterating.

pub fn notify_drained(&mut self)[−]

Notifies that current range is drained.