Enum doku::json::EnumsStyle

pub enum EnumsStyle {
    Commented,
    Separated,
}

Determines how enums should get displayed.

Variants

Commented

Displays enum variants as comments:

use doku::Document;

#[derive(Document)]
struct Person {
    favourite_color: Color,
}

#[derive(Document)]
enum Color {
    Red,
    Green,
    Blue,
}

let fmt = doku::json::Formatting {
    enums_style: doku::json::EnumsStyle::Commented,
    ..Default::default()
};

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

doku::assert_doc!(r#"
  {
    // Possible variants:
    // - "Red"
    // - "Green"
    // - "Blue"
    "favourite_color": "Red"
  }
"#, doc);

Separated

Displays enum variants as separated with a pipe:

use doku::Document;

#[derive(Document)]
struct Person {
    favourite_color: Color,
}

#[derive(Document)]
enum Color {
    Red,
    Green,
    Blue,
}

let fmt = doku::json::Formatting {
    enums_style: doku::json::EnumsStyle::Separated,
    ..Default::default()
};

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

doku::assert_doc!(r#"
  {
    "favourite_color": "Red" | "Green" | "Blue"
  }
"#, doc);

Trait Implementations

impl Clone for EnumsStyle

fn clone(&self) -> EnumsStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnumsStyle

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

Formats the value using the given formatter.

impl Default for EnumsStyle

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EnumsStyle

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

Deserialize this value from the given Serde deserializer.