Struct DocumentFormatter 

pub struct DocumentFormatter { /* private fields */ }

Document formatter for converting API references to various output formats

Implementations

impl DocumentFormatter

pub fn new(config: GeneratorConfig) -> DocumentFormatter

Create a new document formatter

pub fn with_theme( config: GeneratorConfig, theme: ThemeConfig, ) -> DocumentFormatter

Create formatter with custom theme

pub fn format_json( &self, api_ref: &ApiReference, ) -> Result<String, SklearsError>

Format API reference as JSON

pub fn format_html( &self, api_ref: &ApiReference, ) -> Result<String, SklearsError>

Format API reference as HTML

pub fn format_markdown( &self, api_ref: &ApiReference, ) -> Result<String, SklearsError>

Format API reference as Markdown

pub fn format_interactive( &self, api_ref: &ApiReference, ) -> Result<String, SklearsError>

Format API reference as interactive HTML

pub fn format_openapi( &self, api_ref: &ApiReference, ) -> Result<String, SklearsError>

Format API reference as OpenAPI specification

pub fn set_theme(&mut self, theme: ThemeConfig)

Set custom theme

pub fn add_template(&mut self, name: String, template: String)

Add custom template

Trait Implementations

impl Clone for DocumentFormatter

fn clone(&self) -> DocumentFormatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentFormatter

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

Formats the value using the given formatter.

impl Default for DocumentFormatter

fn default() -> DocumentFormatter

Returns the “default value” for a type.