Struct TableIndex 

#[non_exhaustive]
pub struct TableIndex {
    pub column: Vec<u8>,
    pub kind: IndexKind,
    pub values: Vec<Vec<u8>>,
}

One declared secondary index: a column and a scalar kind, plus the stored VALUES columns residual FILTER/SORT read.

use kevy_index::{IndexKind, TableIndex};
let mut ix = TableIndex::new("at", IndexKind::Range);
ix.values.push(b"city".to_vec());
assert_eq!((ix.column.as_slice(), ix.values.len()), (&b"at"[..], 1));

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.

column: Vec<u8>

Declared column the index reads.

let t = declare("TABLE.DECLARE t PREFIX t: PK id COLUMN id i64 COLUMN at i64 INDEX at range")?;
assert_eq!(t.indexes[0].column, b"at");
assert_eq!(t.compile()?[0].name(), b"t.at", "the column names the compiled index");

kind: IndexKind

Range or Unique — nothing else compiles from a table (aggregates stay a direct IDX.CREATE KIND agg declaration).

let t = declare("TABLE.DECLARE t PREFIX t: PK id COLUMN id i64 INDEX id unique")?;
assert_eq!(t.indexes[0].kind, IndexKind::Unique);

values: Vec<Vec<u8>>

Declared columns stored per row (typed from the column decls).

let t = declare("TABLE.DECLARE t PREFIX t: PK id COLUMN id i64 COLUMN city str INDEX id range VALUES city")?;
assert_eq!(t.indexes[0].values, [b"city".to_vec()]);
assert_eq!(t.compile()?[0].values().len(), 1, "stored alongside each entry");

Implementations

impl TableIndex

pub fn new(column: impl Into<Vec<u8>>, kind: IndexKind) -> TableIndex

An index of kind on column, storing no VALUES.

use kevy_index::{IndexKind, TableIndex};
assert!(TableIndex::new("id", IndexKind::Unique).values.is_empty());

Trait Implementations

impl Clone for TableIndex

fn clone(&self) -> TableIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableIndex

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

Formats the value using the given formatter.

impl Eq for TableIndex

impl Hash for TableIndex

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TableIndex

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TableIndex