Enum PrimaryKey

pub enum PrimaryKey<'a> {
    Flat {
        name: &'a str,
        field_id: FieldId,
    },
    Nested {
        name: &'a str,
    },
}

A type that represent the type of primary key that has been set for this index, a classic flat one or a nested one.

Variants

Flat

Fields

name: &'a str

field_id: FieldId

Nested

Fields

name: &'a str

Implementations

impl<'a> PrimaryKey<'a>

pub fn new(path: &'a str, fields: &impl FieldIdMapper) -> Option<Self>

pub fn new_or_insert( path: &'a str, fields: &mut impl MutFieldIdMapper, ) -> StdResult<Self, UserError>

pub fn name(&self) -> &'a str

pub fn document_id( &self, document: &KvReader<FieldId>, fields: &impl FieldIdMapper, ) -> Result<StdResult<String, DocumentIdExtractionError>>

pub fn extract_docid_from_db<'pl, 'bump: 'pl, Mapper: FieldIdMapper>( &self, document: &'pl KvReaderFieldId, db_fields_ids_map: &Mapper, indexer: &'bump Bump, ) -> Result<DeOrBumpStr<'pl, 'bump>>

pub fn extract_fields_and_docid<'pl, 'bump: 'pl, Mapper: MutFieldIdMapper>( &self, document: &'pl RawValue, new_fields_ids_map: &mut Mapper, indexer: &'bump Bump, ) -> Result<DeOrBumpStr<'pl, 'bump>>

pub fn possible_level_names( &self, ) -> impl Iterator<Item = (&'a str, &'a str)> + '_

Returns an Iterator that gives all the possible fields names the primary key can have depending of the first level name and depth of the objects.

Trait Implementations

impl<'a> Clone for PrimaryKey<'a>

fn clone(&self) -> PrimaryKey<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PrimaryKey<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for PrimaryKey<'a>