Struct Enum

Source

pub struct Enum { /* private fields */ }

Expand description

Defines an enumeration.

Implementations§

Source §

impl Enum

Source

pub fn new(name: &str) -> Self

Returns a enum definition with the provided name.

§Arguments

name - The name of the enum.

§Examples

use rust_codegen::Enum;
 
let foo_enum = Enum::new("Foo");

Source

pub fn ty(&self) -> &Type

Returns a reference to the enum’s type.

§Examples

use rust_codegen::Enum;
 
let foo_enum = Enum::new("Foo");
println!("{:?}", foo_enum.ty());

Source

pub fn vis(&mut self, vis: &str) -> &mut Self

Set the enum’s visibility.

§Arguments

vis - The visibility of the enum.

§Examples

use rust_codegen::Enum;
 
let mut foo_enum = Enum::new("Foo");
foo_enum.vis("pub");

Source

pub fn generic(&mut self, name: &str) -> &mut Self

Add a generic to the enum.

§Arguments

name - The name of the generic.

§Examples

use rust_codegen::Enum;
 
let mut foo_enum = Enum::new("Foo");
foo_enum.generic("T");

Source

pub fn bound<T>(&mut self, name: &str, ty: T) -> &mut Self
where T: Into<Type>,

Add a where bound to the enum.

§Arguments

name - The name of the bound.
ty - The type of the bound.

§Examples

use rust_codegen::Enum;
 
let mut foo_enum = Enum::new("Foo");
foo_enum.bound("T", "Default");

Source

pub fn doc(&mut self, docs: &str) -> &mut Self

Set the enum’s documentation.

§Arguments

docs - The docs to set for the enum.

§Examples

use rust_codegen::Enum;
 
let mut foo_enum = Enum::new("Foo");
foo_enum.doc("Sample Foo enum documentation");

Source

pub fn derive(&mut self, name: &str) -> &mut Self

Add a new type that the enum should derive.

§Arguments

name - The name of the derive.

§Examples

use rust_codegen::Enum;
 
let mut foo_enum = Enum::new("Foo");
foo_enum.derive("Debug");

Source

pub fn allow(&mut self, allow: &str) -> &mut Self

Specify lint attribute to supress a warning or error.

§Arguments

allow - The lint attribute to apply.

§Examples

use rust_codegen::Enum;
 
let mut foo_enum = Enum::new("Foo");
foo_enum.allow("dead_code");

Source

pub fn repr(&mut self, repr: &str) -> &mut Self

Specify representation.

§Arguments

repr - The representation to specify.

§Examples

use rust_codegen::Enum;
 
let mut foo_enum = Enum::new("Foo");
foo_enum.repr("C");

Source

pub fn new_variant(&mut self, name: &str) -> &mut Variant

Push a variant to the enum, returning a mutable reference to it.

§Arguments

name - The name of the variant.

§Examples

use rust_codegen::Enum;
 
let mut foo_enum = Enum::new("Foo");
foo_enum.new_variant("FirstVariant");

Source

pub fn push_variant(&mut self, item: Variant) -> &mut Self

Push a variant to the enum.

§Arguments

item - The variant to push to the enum.

§Examples

use rust_codegen::*;
 
let mut foo_enum = Enum::new("Foo");
 
let foo_enum_first_variant = Variant::new("FirstVariant");
foo_enum.push_variant(foo_enum_first_variant);

Source

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

Formats the enum using the given formatter.

§Arguments

fmt - The formatter to use.

§Examples

use rust_codegen::*;
 
let mut dest = String::new();
let mut fmt = Formatter::new(&mut dest);
 
let foo_enum = Enum::new("Foo");
foo_enum.fmt(&mut fmt);