Struct IndexKey 

pub struct IndexKey {
    pub index_id: IndexId,
    pub hashed_values: Vec<[u8; 16]>,
}

IndexKey

Fields

index_id: IndexId

hashed_values: Vec<[u8; 16]>

Implementations

impl IndexKey

pub const STORABLE_MAX_SIZE: u32 = 180u32

pub fn new<E: EntityKind>(entity: &E, index: &IndexSpec) -> Option<Self>

Build an index key from an entity and spec, returning None if a component is missing/non-indexable.

pub fn max_storable() -> Self

Largest representable index key (for sizing).

pub fn bounds_for_prefix( index_id: IndexId, prefix: Vec<[u8; 16]>, ) -> (Self, Self)

Compute the bounded start..end keys for a given hashed prefix under an index id. End is exclusive and created by appending a single 0xFF..0xFF block to the prefix. The returned range can be used with BTreeMap::range.

Trait Implementations

impl Clone for IndexKey

fn clone(&self) -> IndexKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IndexKey

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

Formats the value using the given formatter.

impl Hash for IndexKey

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

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 Ord for IndexKey

fn cmp(&self, other: &IndexKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IndexKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for IndexKey

fn partial_cmp(&self, other: &IndexKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for IndexKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Storable for IndexKey

const BOUND: Bound

The size bounds of the type.

fn to_bytes(&self) -> Cow<'_, [u8]>

Converts the element into a possibly borrowed byte slice.

fn into_bytes(self) -> Vec<u8>

Converts the element into an owned byte vector.

fn from_bytes(bytes: Cow<'_, [u8]>) -> Self

Converts bytes into an element.

fn to_bytes_checked(&self) -> Cow<'_, [u8]>

Like to_bytes, but checks that bytes conform to declared bounds.

fn into_bytes_checked(self) -> Vec<u8>

where Self: Sized,

Like into_bytes, but checks that bytes conform to declared bounds.

fn check_bounds(bytes: &[u8])

Validates that a byte slice fits within this type’s declared bounds.

impl Eq for IndexKey

impl StructuralPartialEq for IndexKey