Struct idb_sys::KeyCursor

impl KeyCursor

pub fn source(&self) -> Object

Returns the ObjectStore or Index the cursor was opened from.

pub fn direction(&self) -> Result<CursorDirection, Error>

Returns the direction of the cursor.

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

Returns the key of the cursor. Returns an Error if the cursor is advancing or is finished.

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

Returns the effective key of the cursor. Returns an Error if the cursor is advancing or is finished.

pub fn request(&self) -> StoreRequest

Returns the StoreRequest that was used to obtain this cursor.

pub fn advance(&self, count: u32) -> Result<(), Error>

Advances the cursor through the next count records in range.

pub fn next(&self, key: Option<&JsValue>) -> Result<(), Error>

Advances the cursor to the next record in range matching or after key (if provided).

pub fn next_primary_key( &self, key: &JsValue, primary_key: &JsValue ) -> Result<(), Error>

Advances the cursor to the next record in range matching or after key and primary key. Returns an Error if the source is not an Index.

pub fn update(&self, value: &JsValue) -> Result<StoreRequest, Error>

Updated the record pointed at by the cursor with a new value.

pub fn delete(&self) -> Result<StoreRequest, Error>

Delete the record pointed at by the cursor with a new value.

Trait Implementations§

impl Clone for KeyCursor

fn clone(&self) -> KeyCursor

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for KeyCursor

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

Formats the value using the given formatter. Read more

impl From<IdbCursor> for KeyCursor

fn from(inner: IdbCursor) -> Self

Converts to this type from the input type.

impl From<KeyCursor> for IdbCursor

fn from(cursor: KeyCursor) -> Self

Converts to this type from the input type.

impl From<KeyCursor> for JsValue

fn from(cursor: KeyCursor) -> Self

Converts to this type from the input type.

impl PartialEq for KeyCursor

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

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

1.0.0 · source§

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 KeyCursor

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 KeyCursor

impl StructuralEq for KeyCursor

impl StructuralPartialEq for KeyCursor

Auto Trait Implementations§

impl UnwindSafe for KeyCursor

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.