Struct cdoc::config::DynamicFormat

pub struct DynamicFormat {
    pub extension: String,
    pub template_prefix: String,
    pub name: String,
    pub renderer: Box<dyn DocumentRenderer>,
    pub include_resources: bool,
    pub layout: Option<String>,
}

Custom output format definition. It should be possible to create almost any text-based output.

Fields

extension: String

Output file extension

template_prefix: String

Template prefix (used in template files)

name: String

Format name (used for build folder)

renderer: Box<dyn DocumentRenderer>

Renderer to use (generic or notebook)

include_resources: bool

Include resources folder in output

layout: Option<String>

Use layout template

Trait Implementations

impl Clone for DynamicFormat

fn clone(&self) -> DynamicFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DynamicFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Format for DynamicFormat

fn extension(&self) -> &str

Return the file extension used for the given format.

fn template_prefix(&self) -> &str

Template format name. Useful if templates are reused across formats as is the case for notebooks which use markdown.

fn name(&self) -> &str

Format name that is used in status messages, build output and in the configuration file.

fn no_parse(&self) -> bool

Return true if the format should not be parsed. This may be removed in the future and is currently only used for the info format which exports all parsed contents in a project.

fn renderer(&self) -> Box<dyn DocumentRenderer>

Return a renderer instance. Currently does not allow for configuration.

fn include_resources(&self) -> bool

Determines whether non-source files should be copied to

fn layout(&self) -> Option<String>

impl Serialize for DynamicFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.