Enum doku::toml::ValuesStyle
source · pub enum ValuesStyle {
Comment(String),
Field,
}
Expand description
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::toml::Formatting {
values_style: doku::toml::ValuesStyle::Comment(
"Default value: ".to_string(),
),
..Default::default()
};
let val = Person {
name: "Janet".to_string(),
};
let doc = doku::to_toml_fmt_val(&fmt, &val);
doku::assert_doc!(r#"
# First name
# Default value: "Janet"
name = "string"
"#, doc);
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::toml::Formatting {
values_style: doku::toml::ValuesStyle::Field,
..Default::default()
};
let val = Person {
name: "Janet".to_string(),
};
let doc = doku::to_toml_fmt_val(&fmt, &val);
doku::assert_doc!(r#"
# First name
name = "Janet"
"#, doc);
Trait Implementations§
source§impl Clone for ValuesStyle
impl Clone for ValuesStyle
source§fn clone(&self) -> ValuesStyle
fn clone(&self) -> ValuesStyle
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for ValuesStyle
impl Debug for ValuesStyle
source§impl Default for ValuesStyle
impl Default for ValuesStyle
source§impl<'de> Deserialize<'de> for ValuesStyle
impl<'de> Deserialize<'de> for ValuesStyle
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl RefUnwindSafe for ValuesStyle
impl Send for ValuesStyle
impl Sync for ValuesStyle
impl Unpin for ValuesStyle
impl UnwindSafe for ValuesStyle
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more