1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
use std::fmt;
use crate::formatter::Formatter;
use crate::type_def::TypeDef;
use crate::variant::Variant;
use crate::r#type::Type;
/// Defines an enumeration.
#[derive(Debug, Clone)]
pub struct Enum {
type_def: TypeDef,
variants: Vec<Variant>,
}
impl Enum {
/// 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");
/// ```
pub fn new(name: &str) -> Self {
Enum {
type_def: TypeDef::new(name),
variants: vec![],
}
}
/// Returns a reference to the enum's type.
///
/// # Examples
///
/// ```
/// use rust_codegen::Enum;
///
/// let foo_enum = Enum::new("Foo");
/// println!("{:?}", foo_enum.ty());
/// ```
pub fn ty(&self) -> &Type {
&self.type_def.ty
}
/// 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");
/// ```
pub fn vis(&mut self, vis: &str) -> &mut Self {
self.type_def.vis(vis);
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");
/// ```
pub fn generic(&mut self, name: &str) -> &mut Self {
self.type_def.ty.generic(name);
self
}
/// 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");
/// ```
pub fn bound<T>(&mut self, name: &str, ty: T) -> &mut Self
where
T: Into<Type>,
{
self.type_def.bound(name, ty);
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");
/// ```
pub fn doc(&mut self, docs: &str) -> &mut Self {
self.type_def.doc(docs);
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");
/// ```
pub fn derive(&mut self, name: &str) -> &mut Self {
self.type_def.derive(name);
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");
/// ```
pub fn allow(&mut self, allow: &str) -> &mut Self {
self.type_def.allow(allow);
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");
/// ```
pub fn repr(&mut self, repr: &str) -> &mut Self {
self.type_def.repr(repr);
self
}
/// 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");
/// ```
pub fn new_variant(&mut self, name: &str) -> &mut Variant {
self.push_variant(Variant::new(name));
self.variants.last_mut().unwrap()
}
/// 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);
/// ```
pub fn push_variant(&mut self, item: Variant) -> &mut Self {
self.variants.push(item);
self
}
/// 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);
/// ```
pub fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
self.type_def.fmt_head("enum", &[], fmt)?;
fmt.block(|fmt| {
for variant in &self.variants {
variant.fmt(fmt)?;
}
Ok(())
})
}
}