doku 0.21.1

A framework for documenting Rust data structures
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

use super::*;

impl Ctxt<'_, '_, '_> {
    pub(super) fn print_bool(&mut self) {
        self.print_scalar(self.first_example().unwrap_or("true"));
    }

    pub(super) fn print_float(&mut self) {
        self.print_scalar(self.first_example().unwrap_or("123.45"));
    }

    pub(super) fn print_integer(&mut self) {
        self.print_scalar(self.first_example().unwrap_or("123"));
    }

    pub(super) fn print_string(&mut self) {
        let first_example = self.first_example().unwrap_or("string");
        if !self.is_key || self.fmt.objects_style.surround_keys_with_quotes {
            self.print_scalar(&format!("\"{}\"", first_example));
        } else {
            self.print_scalar(first_example);
        }
    }

    fn print_scalar(&mut self, val: &str) {
        self.comment_scalar();
        self.sketch_scalar(val);
    }

    fn comment_scalar(&mut self) {
        let prefix =
            if let ValuesStyle::Comment(prefix) = &self.fmt.values_style {
                prefix
            } else {
                return;
            };

        let val = if let Some(val) = self.val.and_then(value_to_string) {
            val
        } else {
            return;
        };

        self.out.append_comment(|comment| {
            swrite!(comment, if !comment.is_empty(), "\n");
            swrite!(comment, "{}{}", prefix, val);
        });
    }

    fn sketch_scalar(&mut self, val: &str) {
        if let ValuesStyle::Field = self.fmt.values_style {
            if let Some(val) = self.val.and_then(value_to_string) {
                self.out.write(val);
                return;
            }
        }

        self.out.write(val);
    }
}