Struct SecondaryIndex 

pub struct SecondaryIndex { /* private fields */ }

One immutable runtime index definition.

Implementations

impl SecondaryIndex

pub fn non_unique<N, I, F>( name: N, generation: u64, extractor_id: I, extractor: F, ) -> Result<Self, Error>

where N: AsRef<[u8]>, I: Into<String>, F: Fn(&[u8], &[u8]) -> Result<Vec<Vec<u8>>, SecondaryIndexError> + Send + Sync + 'static,

Define a non-unique keys-only index from a zero-or-more term callback.

pub fn builder<N, I>( name: N, generation: u64, extractor_id: I, ) -> SecondaryIndexBuilder

where N: AsRef<[u8]>, I: Into<String>,

Start a general runtime definition builder.

pub fn name(&self) -> &[u8]

Stable arbitrary-byte index name.

pub fn generation(&self) -> u64

Monotonically increasing semantic definition generation.

pub fn extractor_id(&self) -> &str

Application-controlled identity for deterministic extractor semantics.

pub fn projection(&self) -> IndexProjection

Projection mode for physical index values.

pub fn limits(&self) -> &SecondaryIndexLimits

Resource bounds attached to this definition.

pub fn extract( &self, primary_key: &[u8], source_value: &[u8], ) -> Result<Vec<SecondaryIndexEntry>, Error>

Run and validate the deterministic extractor for one record.

Trait Implementations

impl Clone for SecondaryIndex

fn clone(&self) -> SecondaryIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecondaryIndex

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

Formats the value using the given formatter.