apivolve_generator_api 0.1.1

Api for creating generators for Apivolve, an API evolution tool that helps keep your APIs backwards compatible yet clean.
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

use ::std::fmt;

use ::semver::Version;
use ::serde::Deserialize;
use ::serde::Serialize;

use crate::gen1::data::{Message, Party, TypeDeclaration};

#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct VersionEvolution {
    pub version: Version,
    #[serde(flatten)]
    pub checksum: Checksum,
    pub declaration: Vec<(ChangeStatus, TypeDeclaration)>,
    pub parties: Vec<(ChangeStatus, Party)>,
    pub messages: Vec<MessageOperation>,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum ChangeStatus {
    Unchanged { same_as: Version },
    New,
    Changed { previous: Version },
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum MessageOperation {
    /// This message is the same as in the given later version.
    Unchanged { same_as: Version, typ: Message },
    /// This message is new or changed, but will be converted to a newer
    /// version after parsing, it won't be handled by user code.
    Convert {
        parse_typ: Message,
        target_version: Version,
        target_typ: Message,
    },
    /// This object is new or changed, and will be handled by user code,
    /// either because it is the latest version, or because there was a
    /// backwards-incompatible change.
    Implement { typ: Message },
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct Checksum {
    value: String,
}

impl fmt::Display for Checksum {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.value)
    }
}