Skip to main content

DxDocumentable

driven::dx_integration

Trait DxDocumentable 

Source 
pub trait DxDocumentable {
    // Required methods
    fn to_dx_markdown(&self) -> Result<String>;
    fn to_dx_markdown_with_config(
        &self,
        config: &DxMarkdownConfig,
    ) -> Result<String>;
    fn to_dxm_document(&self) -> Result<DxmDocument>;
}
Expand description

Trait for types that can generate DX Markdown documentation

Required Methods§

Source

fn to_dx_markdown(&self) -> Result<String>

Generate DX Markdown documentation with default config

Source

fn to_dx_markdown_with_config( &self, config: &DxMarkdownConfig, ) -> Result<String>

Generate DX Markdown documentation with custom config

Source

fn to_dxm_document(&self) -> Result<DxmDocument>

Generate DX Markdown as a DxmDocument

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§