Struct parser_database::IndexFieldPath

pub struct IndexFieldPath { /* private fields */ }

Defines a path to a field that is not directly in the model.

type A {
  field String
}

model A {
  id Int @id
  a  A

  @@index([a.field])
  //       ^this thing here, path separated with `.`
}

Implementations

impl IndexFieldPath

pub fn root(&self) -> ScalarFieldId

The starting point of the index path. If the indexed field is not in a composite type, returns the same value as field_in_index.

type A {
  field String
}

model A {
  id Int @id
  a  A
//^here

  @@index([a.field])
}

pub fn path(&self) -> &[(CompositeTypeId, FieldId)]

The path after root. Empty if the field is not pointing to a composite type.

type A {
  field String
//^the path is a vector of one element, pointing to this field.
}

model A {
  id Int @id
  a  A

  @@index([a.field])
}

pub fn field_in_index( &self ) -> Either<ScalarFieldId, (CompositeTypeId, FieldId)>

The field that gets included in the index. Can either be in the model, or in a composite type embedded in the model. Returns the same value as the root method if the field is in a model rather than in a composite type.

Trait Implementations

impl Clone for IndexFieldPath

fn clone(&self) -> IndexFieldPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexFieldPath

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

Formats the value using the given formatter.

impl PartialEq for IndexFieldPath

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