Struct IndexDef 

pub struct IndexDef {
    pub schema: &'static str,
    pub table: &'static str,
    pub name: &'static str,
    pub name_explicit: bool,
    pub columns: &'static [IndexColumnDef],
    pub is_unique: bool,
    pub where_clause: Option<&'static str>,
    pub method: Option<&'static str>,
    pub with: Option<&'static str>,
    pub concurrently: bool,
}

Const-friendly index definition

Fields

schema: &'static str

Schema name

table: &'static str

Parent table name

name: &'static str

Index name

name_explicit: bool

Whether the index name was explicitly specified

columns: &'static [IndexColumnDef]

Columns included in the index

is_unique: bool

Is this a unique index?

where_clause: Option<&'static str>

WHERE clause for partial indexes

method: Option<&'static str>

Index method (btree, hash, etc.)

with: Option<&'static str>

Storage parameters (WITH clause)

concurrently: bool

Create concurrently?

Implementations

impl IndexDef

pub const fn new( schema: &'static str, table: &'static str, name: &'static str, columns: &'static [IndexColumnDef], ) -> Self

Create a new index definition

pub const fn unique(self) -> Self

Make this a unique index

pub const fn explicit_name(self) -> Self

Mark the name as explicitly specified

pub const fn where_clause(self, clause: &'static str) -> Self

Set WHERE clause for partial index

pub const fn method(self, method: &'static str) -> Self

Set index method

pub const fn with(self, params: &'static str) -> Self

Set storage parameters (WITH clause)

pub const fn concurrently(self) -> Self

Set concurrently flag

pub fn into_index(self) -> Index

Convert to runtime Index type

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 Index

fn from(def: IndexDef) -> Self

Converts to this type from the input type.

impl Hash for IndexDef

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 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 Copy for IndexDef

impl Eq for IndexDef

impl StructuralPartialEq for IndexDef