Struct newdoc::Module

pub struct Module {
    pub file_name: String,
    pub include_statement: String,
    pub text: String,
    /* private fields */
}

A representation of the module with all its metadata and the generated AsciiDoc content

Fields

file_name: String

include_statement: String

text: String

Implementations

impl Module

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

The constructor for the Module struct. Creates a basic version of Module without any optional features.

impl Module

pub fn write_file(&self, options: &Options) -> Result<()>

Write the generated module content to the path specified in options with the set file name.

Trait Implementations

impl Debug for Module

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.

impl PartialEq for Module

fn eq(&self, other: &Module) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Module

impl StructuralPartialEq for Module