Struct query_structure::ast::Enum

pub struct Enum {
    pub name: Identifier,
    pub values: Vec<EnumValue>,
    pub attributes: Vec<Attribute>,
    pub span: Span,
    pub inner_span: Span,
    /* private fields */
}

An enum declaration. Enumeration can either be in the database schema, or completely a Prisma level concept.

PostgreSQL stores enums in a schema, while in MySQL the information is in the table definition. On MongoDB the enumerations are handled in the Query Engine.

Fields

name: Identifier

The name of the enum.

enum Foo { ... }
     ^^^

values: Vec<EnumValue>

The values of the enum.

enum Foo {
  Value1
  ^^^^^^
  Value2
  ^^^^^^
}

attributes: Vec<Attribute>

The attributes of this enum.

enum Foo {
  Value1
  Value2

  @@map("1Foo")
  ^^^^^^^^^^^^^
}

span: Span

The location of this enum in the text representation.

inner_span: Span

The span of the inner contents.

Implementations

impl Enum

pub fn iter_values(&self) -> impl ExactSizeIterator

Trait Implementations

impl Clone for Enum

fn clone(&self) -> Enum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Enum

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

Formats the value using the given formatter.

impl Index<EnumValueId> for Enum

type Output = EnumValue

The returned type after indexing.

fn index(&self, index: EnumValueId) -> &<Enum as Index<EnumValueId>>::Output

Performs the indexing (container[index]) operation.

impl WithAttributes for Enum

fn attributes(&self) -> &[Attribute]

The attributes.

impl WithDocumentation for Enum

fn documentation(&self) -> Option<&str>

The documentation string, if defined.

impl WithIdentifier for Enum

fn identifier(&self) -> &Identifier

The identifier.

impl WithSpan for Enum

fn span(&self) -> Span

The span of the node.