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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
use std::fmt::{self, Write};
use crate::field::Field;
use crate::fields::Fields;
use crate::formatter::Formatter;
use crate::type_def::TypeDef;
use crate::r#type::Type;
/// Defines a struct.
#[derive(Debug, Clone)]
pub struct Struct {
type_def: TypeDef,
/// Struct fields
fields: Fields,
/// The attributes for this struct.
attributes: Vec<String>,
}
impl Struct {
/// Return a structure definition with the provided name.
///
/// # Arguments
///
/// * `name` - The name of the struct.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let foo_struct = Struct::new("Foo");
/// ```
pub fn new(name: &str) -> Self {
Struct {
type_def: TypeDef::new(name),
fields: Fields::Empty,
attributes: vec![],
}
}
/// Returns a reference to the type.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let foo_struct = Struct::new("Foo");
/// println!("{:?}", foo_struct.ty());
/// ```
pub fn ty(&self) -> &Type {
&self.type_def.ty
}
/// Set the structure visibility.
///
/// # Arguments
///
/// * `vis` - The visibility of the struct.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let mut foo_struct = Struct::new("Foo");
/// foo_struct.vis("pub");
/// ```
pub fn vis(&mut self, vis: &str) -> &mut Self {
self.type_def.vis(vis);
self
}
/// Add a generic to the struct.
///
/// # Arguments
///
/// * `name` - The name of the generic.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let mut foo_struct = Struct::new("Foo");
/// foo_struct.generic("T");
/// ```
pub fn generic(&mut self, name: &str) -> &mut Self {
self.type_def.ty.generic(name);
self
}
/// Add a `where` bound to the struct.
///
/// # Arguments
///
/// * `name` - The name of the bound.
/// * `ty` - The type of the bound.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let mut foo_struct = Struct::new("Foo");
/// foo_struct.bound("A", "TraitA");
/// ```
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 structure documentation.
///
/// # Arguments
///
/// * `docs` - The documentation to set for the struct.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let mut foo_struct = Struct::new("Foo");
/// foo_struct.doc("Sample struct documentation.");
/// ```
pub fn doc(&mut self, docs: &str) -> &mut Self {
self.type_def.doc(docs);
self
}
/// Add a new type that the struct should derive.
///
/// # Arguments
///
/// * `name` - The name of the type to derive.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let mut foo_struct = Struct::new("Foo");
/// foo_struct.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 add.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let mut foo_struct = Struct::new("Foo");
/// foo_struct.allow("dead_code");
/// ```
pub fn allow(&mut self, allow: &str) -> &mut Self {
self.type_def.allow(allow);
self
}
/// Specify representation.
///
/// * `repr` - The representation to specify.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let mut foo_struct = Struct::new("Foo");
/// foo_struct.repr("C");
/// ```
pub fn repr(&mut self, repr: &str) -> &mut Self {
self.type_def.repr(repr);
self
}
/// Push a named field to the struct.
///
/// A struct can either set named fields with this function or tuple fields
/// with `push_tuple_field`, but not both.
///
/// # Arguments
///
/// * `field` - The named field to push.
///
/// # Examples
///
/// ```
/// use rust_codegen::{Field,Struct};
///
/// let mut foo_struct = Struct::new("Foo");
/// let mut bar_field = Field::new("bar", "i32");
///
/// foo_struct.push_field(bar_field);
/// ```
pub fn push_field(&mut self, field: Field) -> &mut Self {
self.fields.push_named(field);
self
}
/// Add a named field to the struct.
///
/// A struct can either set named fields with this function or tuple fields
/// with `tuple_field`, but not both.
///
/// # Arguments
///
/// * `name` - The name of the field.
/// * `ty` - The type of the field.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let mut foo_struct = Struct::new("Foo");
/// foo_struct.field("bar", "i32");
/// ```
pub fn field<T>(&mut self, name: &str, ty: T) -> &mut Self
where
T: Into<Type>,
{
self.fields.named(name, ty);
self
}
/// Add a tuple field to the struct.
///
/// A struct can either set tuple fields with this function or named fields
/// with `field`, but not both.
///
/// # Arguments
///
/// * `ty` - The type of the tuple field to add.
///
/// # Examples
///
/// ```
/// use rust_codegen::{Struct,Type};
///
/// let mut foo_struct = Struct::new("Foo");
/// let mut bar_type = Type::new("bar");
///
/// foo_struct.tuple_field(bar_type);
/// ```
pub fn tuple_field<T>(&mut self, ty: T) -> &mut Self
where
T: Into<Type>,
{
self.fields.tuple(ty);
self
}
/// Adds an attribute to the struct (e.g. `"#[some_attribute]"`)
///
/// # Arguments
///
/// * `attribute` - The attribute to add.
///
/// # Examples
///
/// ```
/// use rust_codegen::Struct;
///
/// let mut foo_struct = Struct::new("Foo");
/// foo_struct.attr("some_attribute");
/// ```
pub fn attr(&mut self, attribute: &str) -> &mut Self {
self.attributes.push(attribute.to_string());
self
}
/// Formats the struct 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 mut foo_struct = Struct::new("Foo");
/// foo_struct.fmt(&mut fmt);
pub fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
for m in self.attributes.iter() {
write!(fmt, "{}\n", m)?;
}
self.type_def.fmt_head("struct", &[], fmt)?;
self.fields.fmt(fmt)?;
match self.fields {
Fields::Empty => {
write!(fmt, ";\n")?;
}
Fields::Tuple(..) => {
write!(fmt, ";\n")?;
}
_ => {}
}
Ok(())
}
}