Enum parser_database::IndexAlgorithm

#[repr(u8)]
pub enum IndexAlgorithm {
    BTree = 1,
    Hash = 2,
    Gist = 4,
    Gin = 8,
    SpGist = 16,
    Brin = 32,
}

A type of index as defined by the type: ... argument on an index attribute.

@@index([a, b], type: Hash)
                ^^^^^^^^^^

Variants

BTree = 1

Binary tree index (the default in most databases)

Hash = 2

Hash index

Gist = 4

GiST index

Gin = 8

GIN index

SpGist = 16

SP-GiST index

Brin = 32

Brin index

Implementations

impl IndexAlgorithm

pub fn is_btree(self) -> bool

Is this a B-Tree index?

pub fn is_hash(self) -> bool

Hash?

pub fn is_gist(self) -> bool

GiST?

pub fn is_gin(self) -> bool

GIN?

pub fn is_spgist(self) -> bool

SP-GiST?

pub fn is_brin(self) -> bool

BRIN?

pub fn supports_field_type(self, field: IndexFieldWalker<'_>) -> bool

True if the operator class can be used with the given scalar type.

pub fn documentation(self) -> &'static str

Documentation for editor autocompletion.

Trait Implementations

impl BitAnd for IndexAlgorithm

type Output = BitFlags<IndexAlgorithm>

The resulting type after applying the & operator.

fn bitand(self, other: Self) -> Self::Output

Performs the & operation.

impl BitFlag for IndexAlgorithm

fn empty() -> BitFlags<Self>

Create a BitFlags with no flags set (in other words, with a value of 0).

fn all() -> BitFlags<Self>

Create a BitFlags with all flags set.

impl BitOr for IndexAlgorithm

type Output = BitFlags<IndexAlgorithm>

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self::Output

Performs the | operation.

impl BitXor for IndexAlgorithm

type Output = BitFlags<IndexAlgorithm>

The resulting type after applying the ^ operator.

fn bitxor(self, other: Self) -> Self::Output

Performs the ^ operation.

impl Clone for IndexAlgorithm

fn clone(&self) -> IndexAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexAlgorithm

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

Formats the value using the given formatter.

impl Default for IndexAlgorithm

fn default() -> Self

Returns the “default value” for a type.

impl Display for IndexAlgorithm

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

Formats the value using the given formatter.

impl Not for IndexAlgorithm

type Output = BitFlags<IndexAlgorithm>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for IndexAlgorithm

fn eq(&self, other: &IndexAlgorithm) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RawBitFlags for IndexAlgorithm

type Numeric = u8

The underlying integer type.

const EMPTY: Self::Numeric = {transmute(0x00): <types::IndexAlgorithm as enumflags2::_internal::RawBitFlags>::Numeric}

A value with no bits set.

const DEFAULT: Self::Numeric = {transmute(0x00): <types::IndexAlgorithm as enumflags2::_internal::RawBitFlags>::Numeric}

The value used by the Default implementation. Equivalent to EMPTY, unless customized.

const ALL_BITS: Self::Numeric = {transmute(0x3f): <types::IndexAlgorithm as enumflags2::_internal::RawBitFlags>::Numeric}

A value with all flag bits set.

const BITFLAGS_TYPE_NAME: &'static str = "BitFlags<IndexAlgorithm>"

The name of the type for debug formatting purposes.

fn bits(self) -> Self::Numeric

Return the bits as a number type.

impl Copy for IndexAlgorithm

impl StructuralPartialEq for IndexAlgorithm