Struct datamodel_renderer::datamodel::EnumVariant

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

A variant declaration in an enum block.

Implementations

impl<'a> EnumVariant<'a>

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

Create a new enum variant to be used in an enum declaration.

enum Foo {
  Bar
  ^^^ value
}

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

The map attribute of the variant.

enum Foo {
  Bar @map("foo")
            ^^^ this
}

pub fn comment_out(&mut self)

Comments the variant out in the declaration.

enum Foo {
  // Bar
  ^^ adds this
}

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

Documentation of a variant.

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

Trait Implementations

impl<'a> Debug for EnumVariant<'a>

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

Formats the value using the given formatter.

impl<'a> Display for EnumVariant<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for EnumVariant<'a>

fn from(variant: &'a str) -> Self

Converts to this type from the input type.