Struct InitOptions 

pub struct InitOptions {
    pub file: PathBuf,
    pub item_type: ItemType,
    pub id: Option<String>,
    pub name: Option<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>,
    pub force: bool,
}

Options for initializing a new item or adding frontmatter to an existing file.

Fields

file: PathBuf

The file path to create or update.

item_type: ItemType

The item type.

id: Option<String>

Optional ID (will be auto-generated if not provided).

name: Option<String>

Optional name (will be extracted from file or generated if not provided).

description: Option<String>

Optional description.

refines: Vec<String>

Upstream references (refines) - valid for use_case and scenario.

derives_from: Vec<String>

Upstream references (derives_from) - valid for requirement types.

satisfies: Vec<String>

Upstream references (satisfies) - valid for architecture and design types.

specification: Option<String>

Specification text - valid for requirement types.

platform: Option<String>

Target platform - valid for system_architecture.

force: bool

Whether to overwrite existing frontmatter.

Implementations

impl InitOptions

pub fn new(file: PathBuf, item_type: ItemType) -> Self

Creates new init options with required fields.

pub fn with_id(self, id: impl Into<String>) -> Self

Sets the ID.

pub fn with_name(self, name: impl Into<String>) -> Self

Sets the name.

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

Sets the description.

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

Sets the refines references.

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

Sets the derives_from references.

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

Sets the satisfies references.

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

Sets the specification.

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

Sets the platform.

pub fn with_force(self, force: bool) -> Self

Sets the force flag.

Trait Implementations

impl Clone for InitOptions

fn clone(&self) -> InitOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitOptions

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

Formats the value using the given formatter.