Struct idb_sys::KeyRange

pub struct KeyRange { /* private fields */ }

Represents a continuous interval over some data type that is used for keys.

Implementations

impl KeyRange

pub fn only(value: &JsValue) -> Result<Self, Error>

Returns a new KeyRange spanning only key.

pub fn bound(
    lower: &JsValue,
    upper: &JsValue,
    lower_open: Option<bool>,
    upper_open: Option<bool>
) -> Result<Self, Error>

Returns a new KeyRange spanning from lower to upper. If lower_open is true, lower is not included in the range. If upper_open is true, upper is not included in the range.

pub fn lower_bound(
    lower: &JsValue,
    lower_open: Option<bool>
) -> Result<Self, Error>

Returns a new KeyRange starting at key with no upper bound. If lower_open is true, key is not included in the range.

pub fn upper_bound(
    upper: &JsValue,
    upper_open: Option<bool>
) -> Result<Self, Error>

Returns a new KeyRange with no lower bound and ending at key. If upper_open is true, key is not included in the range.

pub fn lower(&self) -> Result<JsValue, Error>

Returns the range’s lower bound, or undefined if none.

pub fn upper(&self) -> Result<JsValue, Error>

Returns the range’s upper bound, or undefined if none.

pub fn lower_open(&self) -> bool

Returns the range’s lower open flag.

pub fn upper_open(&self) -> bool

Returns the range’s upper open flag.

pub fn includes(&self, value: &JsValue) -> Result<bool, Error>

Returns true if key is included in the range, and false otherwise.

Trait Implementations

impl Clone for KeyRange

fn clone(&self) -> KeyRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyRange

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

Formats the value using the given formatter.

impl From<IdbKeyRange> for KeyRange

fn from(inner: IdbKeyRange) -> Self

Converts to this type from the input type.

impl From<KeyRange> for IdbKeyRange

fn from(key_range: KeyRange) -> Self

Converts to this type from the input type.

impl From<KeyRange> for JsValue

fn from(value: KeyRange) -> Self

Converts to this type from the input type.

impl From<KeyRange> for Query

fn from(value: KeyRange) -> Self

Converts to this type from the input type.

impl PartialEq<KeyRange> for KeyRange

fn eq(&self, other: &KeyRange) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<JsValue> for KeyRange

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for KeyRange

impl StructuralEq for KeyRange

impl StructuralPartialEq for KeyRange