Struct PgIndex 

pub struct PgIndex { /* private fields */ }

PostgreSQL index metadata without SQL generation or execution.

Implementations

impl PgIndex

pub const fn new(name: PgIndexName) -> Self

Creates index metadata from a name.

pub fn with_table(self, table: PgTableRef) -> Self

Sets the table reference.

pub const fn with_method(self, method: PgIndexMethod) -> Self

Sets the index method.

pub fn with_columns(self, columns: Vec<PgIndexColumn>) -> Self

Sets indexed columns.

pub fn with_expression(self, expression: PgIndexExpression) -> Self

Adds an index expression label and marks the index as expression-backed.

pub fn with_predicate( self, predicate: impl AsRef<str>, ) -> Result<Self, PgIndexError>

Sets a partial-index predicate label without parsing SQL.

Errors

Returns PgIndexError when the label is empty or contains control characters.

pub const fn with_flags(self, flags: PgIndexFlags) -> Self

Sets index flags.

pub const fn name(&self) -> &PgIndexName

Returns the index name.

pub const fn table(&self) -> Option<&PgTableRef>

Returns the optional table reference.

pub const fn method(&self) -> PgIndexMethod

Returns the index method.

pub fn columns(&self) -> &[PgIndexColumn]

Returns indexed columns.

pub fn expressions(&self) -> &[PgIndexExpression]

Returns expression labels.

pub fn predicate(&self) -> Option<&str>

Returns the optional partial-index predicate label.

pub const fn flags(&self) -> PgIndexFlags

Returns the index flags.

Trait Implementations

impl Clone for PgIndex

fn clone(&self) -> PgIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PgIndex

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

Formats the value using the given formatter.

impl Hash for PgIndex

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 Ord for PgIndex

fn cmp(&self, other: &PgIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PgIndex

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

fn partial_cmp(&self, other: &PgIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PgIndex

impl StructuralPartialEq for PgIndex