Skip to main content

Module

Struct Module 

Source
#[non_exhaustive]
pub struct Module { pub doc: Vec<String>, pub uses: Vec<String>, pub derives: Vec<Derive>, pub items: Vec<Item>, pub root: Root, }
Expand description

A module to generate.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§doc: Vec<String>

Module doc lines, without //!, written after the // @generated marker.

const COMMAND: &str = "cargo codegen";
Module::new(vec![]).with_doc(vec![
    "The block catalogue.".into(),
    String::new(),
    format!("Regenerate with `{COMMAND}`. Edit `codegen/src/spec.rs`."),
    String::new(),
    "Source: reference manual, revision 4, 2025-10-09.".into(),
]);
§uses: Vec<String>

use lines, each written as use <line>;.

§derives: Vec<Derive>

Extra derives for every struct and enum, after Debug, Clone, PartialEq.

Derives that name a cfg follow in one #[cfg_attr(..)] per predicate.

§items: Vec<Item>

The items, in output order.

§root: Root

The runtime path and prelude spelling.

Implementations§

Source§

impl Module

Source

pub fn new(items: Vec<Item>) -> Self

A module of items, with root ::layline in Spelling::Bare and nothing else set.

Source

pub fn with_root(self, root: Root) -> Self

Sets root.

Source

pub fn with_doc(self, doc: Vec<String>) -> Self

Sets doc.

Source

pub fn with_uses(self, uses: Vec<String>) -> Self

Sets uses.

Source

pub fn with_derives(self, derives: Vec<Derive>) -> Self

Sets derives.

Trait Implementations§

Source§

impl Clone for Module

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Module

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.