Struct GeneratorOptions 

pub struct GeneratorOptions {
    pub item_type: ItemType,
    pub id: String,
    pub name: String,
    pub description: Option<String>,
    pub refines: Vec<String>,
    pub derives_from: Vec<String>,
    pub satisfies: Vec<String>,
    pub specification: Option<String>,
    pub platform: Option<String>,
}

Options for generating frontmatter.

Fields

item_type: ItemType

The item type.

id: String

The item ID.

name: String

The item name.

description: Option<String>

Optional description.

refines: Vec<String>

Upstream references (refines).

derives_from: Vec<String>

Upstream references (derives_from).

satisfies: Vec<String>

Upstream references (satisfies).

specification: Option<String>

Specification text (for requirement types).

platform: Option<String>

Target platform (for system_architecture).

Implementations

impl GeneratorOptions

pub fn new(item_type: ItemType, id: String, name: String) -> Self

Creates new generator options with defaults.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description.

pub fn with_refines(self, refs: Vec<String>) -> Self

Adds a refines reference.

pub fn with_derives_from(self, refs: Vec<String>) -> Self

Adds a derives_from reference.

pub fn with_satisfies(self, refs: Vec<String>) -> Self

Adds a satisfies reference.

pub fn with_specification(self, spec: impl Into<String>) -> Self

Sets the specification.

pub fn with_platform(self, platform: impl Into<String>) -> Self

Sets the target platform (for system_architecture).

Trait Implementations

impl Clone for GeneratorOptions

fn clone(&self) -> GeneratorOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratorOptions

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

Formats the value using the given formatter.