usage-lib 6.2.0

Library for working with usage specs
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

use serde::Serialize;

/// The significance of a structured explanatory block.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum SpecAdmonitionKind {
    Note,
    Warning,
}

/// A note or warning whose presentation is chosen by the renderer.
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct SpecAdmonition {
    pub kind: SpecAdmonitionKind,
    pub text: String,
}

impl SpecAdmonition {
    pub fn note(text: impl Into<String>) -> Self {
        Self {
            kind: SpecAdmonitionKind::Note,
            text: text.into(),
        }
    }

    pub fn warning(text: impl Into<String>) -> Self {
        Self {
            kind: SpecAdmonitionKind::Warning,
            text: text.into(),
        }
    }
}