Struct rust_codegen::Struct

source · [−]

pub struct Struct { /* private fields */ }

Expand description

Defines a struct.

Implementations

source

impl Struct

source

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

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");

source

pub fn ty(&self) -> &Type

Returns a reference to the type.

Examples

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

source

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

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");

source

pub fn generic(&mut self, name: &str) -> &mut 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");

source

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

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");

source

pub fn doc(&mut self, docs: &str) -> &mut 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.");

source

pub fn derive(&mut self, name: &str) -> &mut 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");

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 add.

Examples

use rust_codegen::Struct;
 
let mut foo_struct = Struct::new("Foo");
foo_struct.allow("dead_code");

source

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

Specify representation.

repr - The representation to specify.

Examples

use rust_codegen::Struct;
 
let mut foo_struct = Struct::new("Foo");
foo_struct.repr("C");

source

pub fn push_field(&mut self, field: Field) -> &mut 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);

source

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

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");

source

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

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);

source

pub fn attr(&mut self, attribute: &str) -> &mut 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");

source

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

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);