Struct MagmaDocumentation 

pub struct MagmaDocumentation {
    pub ident: Ident,
    pub generics: Generics,
    pub doc: Option<String>,
    pub fields: Vec<MagmaField>,
}

Holds the parsed structure data required to generate the API docs.

Fields

ident: Ident

generics: Generics

doc: Option<String>

fields: Vec<MagmaField>

Implementations

impl MagmaDocumentation

pub fn from_item(s: &ItemStruct, doc_rec: DocRec) -> Result<Self>

Phase 1: Parse the Item into our intermediate representation.

pub fn generate(&self, import_location: &Path) -> Result<TokenStream>

Phase 2: Generate the TokenStream from the intermediate representation.

pub fn generate_for_ref(&self, import_location: &Path) -> Result<TokenStream>

Same as generate, but implements TypeableRow for FooRef<'_> instead of Foo. The schema content (fields, types, docs) is identical — only the implementor differs.