Struct doku::json::Printer

pub struct Printer<'a> { /* fields omitted */ }

Implementations

impl<'a> Printer<'a>

pub fn set_visibility(&mut self, value: Visibility)

Specifies how skip_serializing / skip_deserializing should be understood:

use doku::Document;
use doku::json::*;
use doku::Visibility;
use serde::Serialize;

#[derive(Serialize, Document)]
struct Person {
    name: String,
    #[serde(skip_serializing)]
    password: String,
    surname: String,
}

let doc = Printer::default()
    .with_visibility(Visibility::SerializableOnly)
    .print(&Person::ty());

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

pub fn with_visibility(self, value: Visibility) -> Self

A consuming variant of Self::set_visibility().

pub fn set_formatting(&mut self, value: &'a Formatting)

pub fn with_formatting(self, value: &'a Formatting) -> Self

A consuming variant of Self::set_formatting().

pub fn set_value(&mut self, value: &'a Value)

pub fn with_value(self, value: &'a Value) -> Self

A consuming variant of Self::set_value().

pub fn print(&self, ty: &'a Type) -> String

Trait Implementations

impl<'a> Debug for Printer<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Printer<'a>

fn default() -> Printer<'a>

Returns the “default value” for a type.