idb/range

Types

KeyRange

Type to represent a key range used to query on an IndexedDB object store or index.

pub type KeyRange

Values

all

</>

pub fn all() -> KeyRange

Creates a KeyRange that contains all value.

bound

</>

pub fn bound(
  lower: @internal Key,
  upper: @internal Key,
  exclude_lower_endpoint: Bool,
  exclude_upper_endpoint: Bool,
) -> KeyRange

Creates a KeyRange with both lower and upper bound. The third and fourth argument determines whether or not the lower and upper endpoint value is excluded from the range respectively.

exclusive_lower_bound

</>

pub fn exclusive_lower_bound(key: @internal Key) -> KeyRange

Creates a KeyRange with only a lower bound. The lower endpoint value is excluded from the range.

exclusive_upper_bound

</>

pub fn exclusive_upper_bound(key: @internal Key) -> KeyRange

Creates a KeyRange with only an upper bound. The upper endpoint value is excluded from the range.

is_in_range

</>

pub fn is_in_range(
  key: @internal Key,
  of range: KeyRange,
) -> Bool

Determines whether or not a Key is inside a KeyRange.

lower_bound

</>

pub fn lower_bound(key: @internal Key) -> KeyRange

Creates a KeyRange with only a lower bound. The lower endpoint value is included in the range.

only

</>

pub fn only(key: @internal Key) -> KeyRange

Creates a KeyRange with only a single Key.

upper_bound

</>

pub fn upper_bound(key: @internal Key) -> KeyRange

Creates a KeyRange with only an upper bound. The upper endpoint value is included in the range.