Enum doku::json::ValuesStyle

pub enum ValuesStyle {
    Comment(String),
    Field,
}

Determines how values should get displayed.

Variants

Comment(String)

Displays values outside of objects, as comments:

use doku::Document;
use serde::Serialize;

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

let fmt = doku::json::Formatting {
    values_style: doku::json::ValuesStyle::Comment(
        "Default value: ".to_string(),
    ),
    ..Default::default()
};

let val = Person {
    name: "Janet".to_string(),
};

let doc = doku::to_json_fmt_val(&fmt, &val);

doku::assert_doc!(r#"
  {
    // First name
    // Default value: "Janet"
    "name": "string"
  }
"#, doc);

Tuple Fields of Comment

0: String

Field

Displays values inside of objects, as fields:

use doku::Document;
use serde::Serialize;

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

let fmt = doku::json::Formatting {
    values_style: doku::json::ValuesStyle::Field,
    ..Default::default()
};

let val = Person {
    name: "Janet".to_string(),
};

let doc = doku::to_json_fmt_val(&fmt, &val);

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

Trait Implementations

impl Clone for ValuesStyle

fn clone(&self) -> ValuesStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValuesStyle

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

Formats the value using the given formatter.

impl Default for ValuesStyle

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ValuesStyle

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

Deserialize this value from the given Serde deserializer.