Struct doku::json::AutoComments

pub struct AutoComments {
    pub array_size: bool,
    pub optional: bool,
}

Determines which auto-comments - hints, so to say - should get displayed.

Sometimes Doku is able to automatically infer certain properties about a type and provide a dedicated hint such as “this field is optional”. This struct allows to configure whether you’d like for such comments to be printed or not.

Fields

array_size: bool

When set, displays hints for arrays of known sizes:

use doku::Document;

#[derive(Document)]
struct Person {
    friends: [String; 3],
}

let fmt = doku::json::Formatting {
    auto_comments: doku::json::AutoComments {
        array_size: true,
        ..Default::default()
    },
    ..Default::default()
};

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

doku::assert_doc!(r#"
  {
    // Must contain exactly 3 elements
    "friends": [
      "string",
      /* ... */
    ]
  }
"#, doc);

optional: bool

When set, displays hints for optional values:

use doku::Document;

#[derive(Document)]
struct Person {
    friend: Option<String>,
}

let fmt = doku::json::Formatting {
    auto_comments: doku::json::AutoComments {
        optional: true,
        ..Default::default()
    },
    ..Default::default()
};

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

doku::assert_doc!(r#"
  {
    // Optional
    "friend": "string"
  }
"#, doc);

Implementations

impl AutoComments

pub fn all() -> Self

pub fn none() -> Self

Trait Implementations

impl Clone for AutoComments

fn clone(&self) -> AutoComments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AutoComments

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

Formats the value using the given formatter.

impl Default for AutoComments

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AutoComments

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

Deserialize this value from the given Serde deserializer.