Struct doku::toml::CommentsStyle

pub struct CommentsStyle {
    pub separator: String,
}

Determines the comments style.

Fields

separator: String

String to use as comment separator

use doku::Document;

#[derive(Document)]
struct Person {
    /// First name
    name: String,
}

let fmt = doku::toml::Formatting {
    comments_style: doku::toml::CommentsStyle { separator: "//".to_owned() },
    ..Default::default()
};

let doc = doku::to_toml_fmt::<Person>(&fmt);

doku::assert_doc!(r#"
  // First name
  name = "string"
"#, doc);

Trait Implementations

impl Clone for CommentsStyle

fn clone(&self) -> CommentsStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommentsStyle

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

Formats the value using the given formatter.

impl Default for CommentsStyle

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommentsStyle

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

Deserialize this value from the given Serde deserializer.

impl Serialize for CommentsStyle

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

Serialize this value into the given Serde serializer.