Struct ViewLeaf 

#[non_exhaustive]
pub struct ViewLeaf {
    pub index: Vec<u8>,
    pub min: IndexValue,
    pub max: IndexValue,
}

One leaf: a declared index + the shape it contributes.

use kevy_index::{IndexValue, Leaf};
let adults = Leaf::new("age", IndexValue::I64(18), IndexValue::I64(i64::MAX));
assert_eq!(adults.index, b"age");

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.

index: Vec<u8>

Index name (resolved by the runtime).

use kevy_index::{IndexValue, Leaf};
let leaf = Leaf::new("city", IndexValue::Str(b"a".to_vec()), IndexValue::Str(b"m".to_vec()));
assert_eq!(leaf.index, b"city");

min: IndexValue

Inclusive bounds (EQ = same min/max), already coerced to the index’s type by the runtime at CREATE time.

use kevy_index::{IndexValue, Leaf, Tree};
let leaf = Leaf::new("age", IndexValue::I64(18), IndexValue::I64(65));
assert_eq!(leaf.min, IndexValue::I64(18));
let t = Tree::Leaf(leaf);
assert!(t.contains_values(&|_: &[u8]| Some(IndexValue::I64(18))), "min is inclusive");
assert!(!t.contains_values(&|_: &[u8]| Some(IndexValue::I64(17))));

max: IndexValue

Upper bound.

use kevy_index::{IndexValue, Leaf, Tree};
let leaf = Leaf::new("age", IndexValue::I64(18), IndexValue::I64(65));
assert_eq!(leaf.max, IndexValue::I64(65));
let t = Tree::Leaf(leaf);
assert!(t.contains_values(&|_: &[u8]| Some(IndexValue::I64(65))), "max is inclusive");
assert!(!t.contains_values(&|_: &[u8]| Some(IndexValue::I64(66))));

Implementations

impl Leaf

pub fn new(index: impl Into<Vec<u8>>, min: IndexValue, max: IndexValue) -> Leaf

Rows of index index whose value lies in min..=max (EQ is min == max), bounds already coerced to the index’s type.

use kevy_index::{IndexValue, Leaf};
let eq = Leaf::new("city", IndexValue::Str(b"kyoto".to_vec()), IndexValue::Str(b"kyoto".to_vec()));
assert_eq!(eq.min, eq.max);

Trait Implementations

impl Clone for Leaf

fn clone(&self) -> Leaf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Leaf

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

Formats the value using the given formatter.

impl PartialEq for Leaf

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Leaf