Struct Document

pub struct Document {
    pub content: DocumentContent,
    pub item_path: PathBuf,
    pub item_content: String,
    pub target_path: PathBuf,
    pub identity: String,
    context: Mutex<HashMap<PreprocessorId, PreprocessorOutput>>,
    pub from_library: bool,
    pub out_target_dir: PathBuf,
}

The wrapper around the ParseItem containing additional information the original item and extra context for outputting it.

Fields

content: DocumentContent

The underlying parsed items.

item_path: PathBuf

The original item path.

item_content: String

The original item file content.

target_path: PathBuf

The target path where the document will be written.

identity: String

The document display identity.

context: Mutex<HashMap<PreprocessorId, PreprocessorOutput>>

The preprocessors results.

from_library: bool

Whether the document is from external library.

out_target_dir: PathBuf

The target directory for the doc output.

Implementations

impl Document

pub fn new( item_path: PathBuf, target_path: PathBuf, from_library: bool, out_target_dir: PathBuf, ) -> Self

Create new instance of Document.

pub fn with_content(self, content: DocumentContent, identity: String) -> Self

Set content and identity on the Document.

pub fn add_context(&self, id: PreprocessorId, output: PreprocessorOutput)

Add a preprocessor result to inner document context.

pub fn get_from_context(&self, id: PreprocessorId) -> Option<PreprocessorOutput>

Read preprocessor result from context

fn try_relative_output_path(&self) -> Option<&Path>

pub fn relative_output_path(&self) -> &Path

Returns the relative path of the document output.

impl Document

fn target_src_dir(&self) -> PathBuf

Where all the source files are written to

fn write_function( &self, writer: &mut BufWriter, func: &FunctionDefinition, comments: &Comments, code: &str, ) -> Result<(), Error>

Writes a function to the buffer.

Trait Implementations

impl AsDoc for Document

fn as_doc(&self) -> AsDocResult

Formats a parse tree item into a doc string.

impl Debug for Document

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1024 bytes