Struct IndexEntity 

#[non_exhaustive]
pub struct IndexEntity {
    pub name: String,
    pub type: String,
    pub table_columns: Vec<String>,
    pub unique: bool,
    pub custom_features: Option<Struct>,
    /* private fields */
}

Index is not used as an independent entity, it is retrieved as part of a Table entity.

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: String

The name of the index.

type: String

Type of index, for example B-TREE.

table_columns: Vec<String>

Table columns used as part of the Index, for example B-TREE index should list the columns which constitutes the index.

unique: bool

Boolean value indicating whether the index is unique.

custom_features: Option<Struct>

Custom engine specific features.

Implementations

impl IndexEntity

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_type<T: Into<String>>(self, v: T) -> Self

Sets the value of r#type.

pub fn set_table_columns<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of table_columns.

pub fn set_unique<T: Into<bool>>(self, v: T) -> Self

Sets the value of unique.

pub fn set_custom_features<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of custom_features.

pub fn set_or_clear_custom_features<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of custom_features.

Trait Implementations

impl Clone for IndexEntity

fn clone(&self) -> IndexEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexEntity

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

Formats the value using the given formatter.

impl Default for IndexEntity

fn default() -> IndexEntity

Returns the “default value” for a type.

impl Message for IndexEntity

fn typename() -> &'static str

The typename of this message.

impl PartialEq for IndexEntity

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