Struct KeyCursor

pub struct KeyCursor<'t, M, K> { /* private fields */ }

Cursor on an object store or index

Implementations

impl<'t, M, K> KeyCursor<'t, M, K>

where M: Model, K: Serialize + DeserializeOwned,

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

Returns the direction of the cursor

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

Returns the key at the current position of the cursor

pub fn primary_key(&self) -> Result<Option<M::Key>, Error>

Returns the primary key at the current position of the cursor

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

Advances the cursor through the next count records in range.

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

where K: Borrow<Q>, Q: Serialize,

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

pub async fn next_primary_key<Q, R>( &mut self, key: &Q, primary_key: &R, ) -> Result<(), Error>

where K: Borrow<Q>, Q: Serialize, M::Key: Borrow<R>, R: Serialize,

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 async fn update<V>(&mut self, value: &V) -> Result<M, Error>

where M: Borrow<V>, V: Serialize,

Updates the value at the current position of the cursor

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

Deletes the value at the current position of the cursor

Trait Implementations

impl<'t, M: Debug, K: Debug> Debug for KeyCursor<'t, M, K>

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

Formats the value using the given formatter.