Struct Input

pub struct Input {
    pub mod_type: ContentType,
    pub title: String,
    pub options: Options,
    pub includes: Option<Vec<String>>,
}

An initial representation of the module with input data, used to construct the Module struct

Fields

mod_type: ContentType

title: String

options: Options

includes: Option<Vec<String>>

Implementations

impl Input

Construct a basic builder for Module, storing information from the user input.

pub fn new(mod_type: ContentType, title: &str, options: &Options) -> Input

pub fn include(self, include_statements: Vec<String>) -> Self

Set the optional include statements for files that this assembly includes

pub fn id(&self) -> String

Create an ID string that is derived from the human-readable title. The ID is usable as:

• An AsciiDoc section ID
• A DocBook section ID
• A file name

Examples

use newdoc::{ContentType, Input, Options};

let mod_type = ContentType::Concept;
let title = "A test -- with #problematic ? characters";
let options = Options::default();
let input = Input::new(mod_type, title, &options);

assert_eq!("a-test-with-problematic-characters", input.id());

pub fn file_name(&self) -> String

Prepare the file name for the generated file.

The file name is based on the module ID, with an optional prefix and the .adoc extension.

Examples

use newdoc::{ContentType, Input, Options};

let mod_type = ContentType::Concept;
let title = "Default file name configuration";
let options = Options::default();
let input = Input::new(mod_type, title, &options);

assert_eq!("con_default-file-name-configuration.adoc", input.file_name());

let mod_type = ContentType::Concept;
let title = "No prefix file name configuration";
let options = Options {
    file_prefixes: false,
    ..Default::default()
};
let input = Input::new(mod_type, title, &options);

assert_eq!("no-prefix-file-name-configuration.adoc", input.file_name());

pub fn anchor(&self) -> String

Prepare the AsciiDoc anchor or ID.

The anchor is based on the module ID, with an optional prefix.

Examples

use newdoc::{ContentType, Input, Options};

let mod_type = ContentType::Concept;
let title = "Default anchor configuration";
let options = Options::default();
let input = Input::new(mod_type, title, &options);

assert_eq!("default-anchor-configuration", input.anchor());

let mod_type = ContentType::Concept;
let title = "Prefix anchor configuration";
let options = Options {
    anchor_prefixes: true,
    ..Default::default()
};
let input = Input::new(mod_type, title, &options);

assert_eq!("con_prefix-anchor-configuration", input.anchor());

impl Input

pub fn text(&self) -> String

Perform string replacements in the modular template that matches the ContentType. Return the template text with all replacements.

Trait Implementations

impl Debug for Input

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

Formats the value using the given formatter.

impl From<Input> for Module

fn from(input: Input) -> Self

Convert the Input builder struct into the finished Module struct.