Struct EncodedKeyRange 

pub struct EncodedKeyRange {
    pub start: Bound<EncodedKey>,
    pub end: Bound<EncodedKey>,
}

Fields

start: Bound<EncodedKey>

end: Bound<EncodedKey>

Implementations

impl EncodedKeyRange

pub fn new(start: Bound<EncodedKey>, end: Bound<EncodedKey>) -> Self

pub fn prefix(prefix: &[u8]) -> Self

Generates a key range for a key prefix, used e.g. for prefix scans.

The exclusive end bound is generated by adding 1 to the value of the last byte. If the last byte(s) is 0xff (so adding 1 would saturation), we instead find the latest non-0xff byte, increment that, and truncate the rest. If all bytes are 0xff, we scan to the end of the range, since there can’t be other prefixes after it.

pub fn with_prefix(&self, prefix: EncodedKey) -> Self

pub fn start_end(start: Option<EncodedKey>, end: Option<EncodedKey>) -> Self

Constructs a key range from an optional inclusive start key to an optional inclusive end key.

• start: If provided, marks the inclusive lower bound of the range. If None, the range is unbounded below.
• end: If provided, marks the inclusive upper bound of the range. If None, the range is unbounded above.

This function does not modify the input keys and assumes they are already exact keys (not prefixes). If you need to scan all keys with a given prefix, use EncodedKeyRange::prefix instead.

Useful for scanning between two explicit keys in a sorted key-value store.

pub fn all() -> Self

Constructs a key range that fragments the entire keyspace.

This range has no lower or upper bounds, making it suitable for full scans over all keys in a sorted key-value store.

Equivalent to: .. (in Rust range syntax)

pub fn parse(str: &str) -> Self

Parses a human-readable range string into a KeyRange.

The expected format is <start>..[=]<end>, where:

• <start> is the inclusive lower bound (optional),
• .. separates the bounds,
• = after .. makes the upper bound inclusive,
• <end> is the upper bound (optional).

Examples:

• "a..z" => start = Included(“a”), end = Excluded(“z”)
• "a..=z" => start = Included(“a”), end = Included(“z”)
• "..z" => start = Unbounded, end = Excluded(“z”)
• "a.." => start = Included(“a”), end = Unbounded

If parsing fails, it defaults to a degenerate range from 0xff to 0xff (empty).

Trait Implementations

impl Clone for EncodedKeyRange

fn clone(&self) -> EncodedKeyRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncodedKeyRange

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

Formats the value using the given formatter.

impl From<EncodedIndexKeyRange> for EncodedKeyRange

fn from(range: EncodedIndexKeyRange) -> Self

Converts to this type from the input type.

impl RangeBounds<EncodedKey> for EncodedKeyRange

fn start_bound(&self) -> Bound<&EncodedKey>

Start index bound.

fn end_bound(&self) -> Bound<&EncodedKey>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

fn is_empty(&self) -> bool

where T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.