Struct IndexCursor 

#[non_exhaustive]
pub struct IndexCursor {
    pub value: IndexValue,
    pub key: Vec<u8>,
}

Opaque pagination cursor: the last (value, key) served. Encoded by the runtime into the wire cursor; None = start.

use kevy_index::{Cursor, IndexValue};
let c = Cursor::new(IndexValue::I64(30), b"user:7".to_vec());
assert_eq!(c.key, b"user:7");

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

value: IndexValue

Last value served.

let mut s = Segment::new();
for (k, v) in [(b"a", 1), (b"b", 2)] { s.apply(k, None, Some(IndexValue::I64(v))); }
let (_, next) = s.range(&IndexValue::I64(0), &IndexValue::I64(9), None, 1);
assert_eq!(next.expect("more to read").value, IndexValue::I64(1));

key: Vec<u8>

Last key served (tiebreak within a value).

let mut s = Segment::new();
for k in [b"x", b"y"] { s.apply(k, None, Some(IndexValue::I64(5))); }
let (_, next) = s.range(&IndexValue::I64(5), &IndexValue::I64(5), None, 1);
assert_eq!(next.expect("more to read").key, b"x", "ties break on the key");

Implementations

impl Cursor

pub fn new(value: IndexValue, key: Vec<u8>) -> Cursor

The cursor just past (value, key), the last entry served.

use kevy_index::{Cursor, IndexValue};
assert_eq!(Cursor::new(IndexValue::I64(1), b"k".to_vec()).value, IndexValue::I64(1));

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl Eq for Cursor

impl PartialEq for Cursor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Cursor