Struct datamodel_renderer::datamodel::Enum

pub struct Enum<'a> { /* private fields */ }

An enum block in a PSL file.

Implementations

impl<'a> Enum<'a>

pub fn new(name: impl Into<Cow<'a, str>>) -> Self

Create a new enum declaration block. Will not be valid without adding at least one variant.

enum TrafficLight {
//   ^^^^^^^^^^^^ name
}

pub fn documentation(&mut self, documentation: impl Into<Cow<'a, str>>)

The documentation on top of the enum declaration.

/// This here is the documentation.
enum Foo {
  Bar
}

pub fn schema(&mut self, schema: impl Into<Cow<'a, str>>)

The schema attribute of the enum block

enum Foo {
  Bar

  @@schema("public")
            ^^^^^^ this
}

pub fn push_variant(&mut self, variant: impl Into<EnumVariant<'a>>)

Add a new variant to the enum declaration. If passing a string slice, adds a simple enum variant. Additionally an EnumVariant can be constructed and passed for additional settings.

enum Foo {
  Bar
  ^^^ this
}

pub fn map(&mut self, mapped_name: impl Into<Cow<'a, str>>)

Sets the block level map attribute.

enum Foo {
  @@map("bar")
         ^^^ this
}

Trait Implementations

impl<'a> Debug for Enum<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Enum<'a>

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

Formats the value using the given formatter.