Trait cdoc::config::Format

pub trait Format: DynClone + Debug + Send + Sync + Serialize + Deserialize {
    // Required methods
    fn extension(&self) -> &str;
    fn template_prefix(&self) -> &str;
    fn name(&self) -> &str;
    fn no_parse(&self) -> bool;
    fn renderer(&self) -> Box<dyn DocumentRenderer>;
    fn include_resources(&self) -> bool;
    fn use_layout(&self) -> bool;
}

Implementors define a format. This trait should make format extensions easy to implement.

Required Methods

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 use_layout(&self) -> bool

Trait Implementations

impl<'clone> Clone for Box<dyn Format + 'clone>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'clone> Clone for Box<dyn Format + Send + 'clone>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'clone> Clone for Box<dyn Format + Send + Sync + 'clone>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'clone> Clone for Box<dyn Format + Sync + 'clone>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for Box<dyn Format>

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

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for Box<dyn Format + Send>

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

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for Box<dyn Format + Send + Sync>

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

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for Box<dyn Format + Sync>

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

Deserialize this value from the given Serde deserializer.

impl Display for dyn Format

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

Formats the value using the given formatter.

impl Hash for dyn Format

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

impl PartialEq<dyn Format> for dyn Format

fn eq(&self, other: &Self) -> 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<'typetag> Serialize for dyn Format + 'typetag

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

Serialize this value into the given Serde serializer.

impl<'typetag> Serialize for dyn Format + Send + 'typetag

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

Serialize this value into the given Serde serializer.

impl<'typetag> Serialize for dyn Format + Send + Sync + 'typetag

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

Serialize this value into the given Serde serializer.

impl<'typetag> Serialize for dyn Format + Sync + 'typetag

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

Serialize this value into the given Serde serializer.

impl Strictest for dyn Format

type Object = dyn Format + Send + Sync

impl Eq for dyn Format

Implementors

impl Format for DynamicFormat

impl Format for HtmlFormat

impl Format for InfoFormat

impl Format for LaTexFormat

impl Format for MarkdownFormat

impl Format for NotebookFormat