Struct IndexDefinition 

pub struct IndexDefinition {
    pub name: String,
    pub kind: StoredIndexKind,
    pub entity: StoredIndexEntity,
    pub label: Option<String>,
    pub additional_labels: Vec<String>,
    pub properties: Vec<String>,
    pub options: BTreeMap<String, IndexConfigValue>,
    pub state: StoredIndexState,
}

Fields

name: String

kind: StoredIndexKind

entity: StoredIndexEntity

label: Option<String>

Some(label_or_type) for property indexes. For LOOKUP token indexes the label/type is the wildcard captured by labels(n) or type(r) and is recorded as None.

additional_labels: Vec<String>

Extra labels beyond label. Only populated for FULLTEXT indexes declared with the (n:A|B|C) form. all_labels() walks the union.

properties: Vec<String>

options: BTreeMap<String, IndexConfigValue>

state: StoredIndexState

Implementations

impl IndexDefinition

pub fn all_labels(&self) -> impl Iterator<Item = &str>

Iterate every label / rel-type this index covers. For non-fulltext kinds this is at most one element.

Trait Implementations

impl Clone for IndexDefinition

fn clone(&self) -> IndexDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IndexDefinition

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IndexDefinition