Struct Keyword 

pub struct Keyword {
    pub name: &'static str,
    pub category: KeywordCategory,
    pub description: &'static str,
    pub default_value: Option<&'static str>,
    pub example: Option<&'static str>,
    pub required: bool,
}

Keyword documentation entry Documentation entry for a single configuration keyword.

This struct holds all relevant information for a keyword, including its name, category, description, default value, example usage, and whether it is a required parameter.

Fields

name: &'static str

The name of the keyword (e.g., “nprocs”, “method”).

category: KeywordCategory

The category to which this keyword belongs.

description: &'static str

A brief description of what the keyword does.

default_value: Option<&'static str>

The default value of the keyword, if applicable.

example: Option<&'static str>

An example of how to use the keyword in an input file.

required: bool

Indicates whether the keyword is required for a calculation.

Trait Implementations

impl Clone for Keyword

fn clone(&self) -> Keyword

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keyword

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

Formats the value using the given formatter.