Struct IndexDef

#[non_exhaustive]
pub struct IndexDef {
    pub name: Box<str>,
    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: Box<str>

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

accessor_name: Option<Identifier>

Accessor name for the index used in client codegen.

This is set the user and should not be assumed to follow any particular format.

May be set to None if this is an auto-generated index for which the user has not supplied a name. In this case, no client code generation for this index will be performed.

This name is not visible in the system tables, it is only used for client codegen.

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 RawIndexDefV9

fn from(val: IndexDef) -> Self

Converts to this type from the input type.

impl ModuleDefLookup for IndexDef

type Key<'a> = &'a str

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