Struct IndexDef 

#[non_exhaustive]
pub struct IndexDef {
    pub name: RawIdentifier,
    pub source_name: RawIdentifier,
    pub accessor_name: Option<Identifier>,
    pub algorithm: IndexAlgorithm,
}

A struct representing the validated definition of a database index.

Cannot be created directly. Construct a ModuleDef by validating a RawModuleDef instead, and then access the index from there.

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.

name: RawIdentifier

The name of the index. Must be unique within the containing ModuleDef.

In V9 and earlier, this was system generated. in V10, this can be optionally passed in by the user, but if not passed in, it will be generated by the system using the same algorithm as V9 and earlier.

source_name: RawIdentifier

This will be the same as name for RawModuleDefV9. For RawModuleDefV10, this is an auto-generated globally unique name derived from the module source.

This exists as a hacky workaround to make the index_name_from_id syscall work without requiring the module to know about the canonical index name field. It serves as an alias for name in Database.

accessor_name: Option<Identifier>

The name of the index to use for client code generation.

In V9 and earlier, this could be supplied by the user via the accessor macro in bindings. In those versions, this may be None if the index was auto-generated and no accessor name was provided by the user. In that case, no client code will be generated for this index.

algorithm: IndexAlgorithm

The algorithm parameters for the index.

Implementations

impl IndexDef

pub fn generated(&self) -> bool

Whether this index was generated by the system.

Trait Implementations

impl Clone for IndexDef

fn clone(&self) -> IndexDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexDef

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

Formats the value using the given formatter.

impl From<IndexDef> for RawIndexDefV10

fn from(val: IndexDef) -> Self

Converts to this type from the input type.

impl From<IndexDef> for RawIndexDefV9

fn from(val: IndexDef) -> Self

Converts to this type from the input type.

impl ModuleDefLookup for IndexDef

type Key<'a> = &'a RawIdentifier

A reference to a definition of this type within a module def. This reference should be portable across migrations.

fn key(&self) -> Self::Key<'_>

Get a reference to this definition.

fn lookup<'a>(module_def: &'a ModuleDef, key: Self::Key<'_>) -> Option<&'a Self>

Look up this entity in the module def.

impl PartialEq for IndexDef

fn eq(&self, other: &IndexDef) -> 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 Eq for IndexDef

impl StructuralPartialEq for IndexDef