Struct Field

pub struct Field {
    pub name: String,
    pub ty: Type,
    pub documentation: Vec<String>,
    pub annotation: Vec<String>,
}

Defines a struct field.

Fields

name: String

Field name

ty: Type

Field type

documentation: Vec<String>

Field documentation

annotation: Vec<String>

Field annotation

Implementations

impl Field

pub fn new<T>(name: &str, ty: T) -> Self

where T: Into<Type>,

Return a field definition with the provided name and type.

Arguments

• name - The name of the field.
• ty - The type of the field.

Examples

use rust_codegen::Field;
 
let count_field = Field::new("count", "i32");

pub fn doc(&mut self, documentation: Vec<&str>) -> &mut Self

Set the field’s documentation.

Arguments

• documentation - The documentation to set for the field.

Examples

use rust_codegen::Field;
 
let count_field = Field::new("count", "i32").doc(Vec::from(["The number of Foos"]));

pub fn annotation(&mut self, annotation: Vec<&str>) -> &mut Self

Set the field’s annotation.

Arguments

• annotation - The annotation to set for the field.

Examples

use rust_codegen::Field;
 
let count_field = Field::new("count", "i32").annotation(Vec::from(["serde(rename = \"name\")"]));

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.