Struct ExtractorConfig 

pub struct ExtractorConfig {

    pub profile: Profile,
    pub rules: DocumentRules,
    pub only_sequences: Vec<String>,
    pub include_process_models: bool,
    pub include_scopes: Vec<VariableScope>,
    pub ignore_skipped: bool,
    pub include_flowcharts: bool,
    pub include_station_options: bool,
    pub include_types: bool,
    pub include_file_custom_data_types: bool,
    pub types_attached_only: bool,
    pub estimate_software_delays: bool,
    pub detailed_popup_messages: bool,
    pub author: String,
    pub company: String,
    pub email: String,
    pub version: String,
    pub show_paths: bool,
    pub recurse_subsequences: bool,
    pub max_depth: usize,
    pub company_logo: Option<String>,
}

Configuration options for the documentation generator.

Fields

profile: Profile

Report profile style.

A profile is a preset for rules; the renderer reads the rules, never the profile, so a caller can start from a preset and change one thing.

rules: DocumentRules

What the document includes.

only_sequences: Vec<String>

Document only these sequences, by name.

Empty means every sequence in the file. Naming one or more narrows the document to them, which is how a caller documents a single subsequence out of a large file without generating the rest.

include_process_models: bool

Whether to analyze and include process models.

include_scopes: Vec<VariableScope>

Variable scopes to include in output.

ignore_skipped: bool

Whether to omit steps whose run mode is Skip.

include_flowcharts: bool

Whether to generate Mermaid control-flow diagrams.

include_station_options: bool

Whether to append station options report.

include_types: bool

Whether to append types report.

include_file_custom_data_types: bool

Whether to extract custom types defined in the file.

types_attached_only: bool

When true, only report types attached to the file.

estimate_software_delays: bool

Whether to estimate minimum software delays.

detailed_popup_messages: bool

Whether to include message details in MessagePopup diagrams.

author: String

Author name for the document header.

company: String

Company name for the document header.

email: String

Author email for the document header.

version: String

Document version for the header.

show_paths: bool

Whether to show file paths under sequence titles.

recurse_subsequences: bool

Whether to recursively analyze and include called subsequence files.

max_depth: usize

Maximum recursion depth for subsequence traversal.

company_logo: Option<String>

Path to an optional company logo image.

Implementations

impl ExtractorConfig

pub fn for_profile(profile: Profile) -> Self

A configuration carrying the rules a profile stands for.

Prefer this over a struct literal: setting profile on its own leaves rules at the default, and the renderer reads the rules, so the document would not change. Override individual rules afterwards:

use rs_teststand_autodoc::data::{ExtractorConfig, Profile};

let mut config = ExtractorConfig::for_profile(Profile::Business);
config.rules.step_tables = true;

Trait Implementations

impl Clone for ExtractorConfig

fn clone(&self) -> ExtractorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtractorConfig

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

Formats the value using the given formatter.

impl Default for ExtractorConfig

fn default() -> Self

Returns the “default value” for a type.