Enum doku::json::DocComments

pub enum DocComments {
    Visible,
    Hidden,
}

Determines if doc-comments should get displayed.

Variants

Visible

Shows doc-comments:

use doku::Document;

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

let fmt = doku::json::Formatting {
    doc_comments: doku::json::DocComments::Visible,
    ..Default::default()
};

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

doku::assert_doc!(r#"
  {
    // First name
    // (aka forename)
    "name": "string"
  }
"#, doc);

Please note that doc-comments are only the ones starting with three slashes.

Hidden

Hides doc-comments:

use doku::Document;

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

let fmt = doku::json::Formatting {
    doc_comments: doku::json::DocComments::Hidden,
    ..Default::default()
};

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

doku::assert_doc!(r#"
  {
    "name": "string"
  }
"#, doc);

Trait Implementations

impl Clone for DocComments

fn clone(&self) -> DocComments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocComments

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

Formats the value using the given formatter.

impl Default for DocComments

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocComments

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

Deserialize this value from the given Serde deserializer.

impl Serialize for DocComments

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

Serialize this value into the given Serde serializer.