chara_card 0.3.0

A library to deal with character card formats and `.charx` in Rust.
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

mod version_specific;

use crate::raw::Error;
use crate::raw::{v1, v2, v3, Version};
use serdev::{Deserialize, Serialize};

/// Represents character card regardless of specification version.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(untagged)]
pub enum CharacterCard {
    /// Represents character card, version 1.
    Flat(v1::CharacterCardData),

    /// Represents character card, version 2 or later.
    Nested(NestedCharacterCard),
}

impl CharacterCard {
    /// Converts form of flat character card to nested form.
    ///
    /// "chara_card_v1" and "1.0" will be used for
    /// `spec` field and `spec_version` field of
    /// character card data.
    ///
    /// It has no effect for nested character card.
    pub fn to_nested(self) -> NestedCharacterCard {
        let flat = match self {
            CharacterCard::Flat(flat) => flat,
            CharacterCard::Nested(nested) => return nested,
        };

        NestedCharacterCard {
            spec: Version::V1.name().unwrap().into(),
            spec_version: Version::V1,
            data: CharacterCardData {
                v1: flat,
                v2: None,
                v3: None,
            },
        }
    }
}

/// Represents nested form of character card.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(validate = "Self::validate")]
pub struct NestedCharacterCard {
    /// Represents specification name of the character card.
    ///
    /// To be consistent with other versions,
    /// "chara_card_v1" is used for CCv1.
    pub spec: String,

    /// Represents specification version of the character card.
    ///
    /// To be consistent with other versions,
    /// "1.0" is used for CCv1.
    pub spec_version: Version,

    /// Represents inner data of the character card.
    pub data: CharacterCardData,
}

impl NestedCharacterCard {
    fn validate(&self) -> Result<(), Error> {
        let Some(spec) = self.spec_version.name() else {
            return Err(Error::UnsupportedVersion(self.spec_version));
        };

        if self.spec != spec {
            return Err(Error::UnsupportedSpec(self.spec.clone()));
        }

        if self.spec_version < Version::V2 {
            return Ok(());
        }

        let Some(v2) = &self.data.v2 else {
            return Err(Error::MissingFeature(Version::V2, "Data".into()));
        };

        if self.spec_version < Version::V3 {
            return Ok(());
        }

        if self.data.v3.is_none() {
            return Err(Error::MissingFeature(Version::V3, "Data".into()));
        }

        if let Some(book) = &v2.character_book {
            for entry in &book.entries {
                if entry.v3.is_some() {
                    continue;
                }

                return Err(Error::MissingFeature(Version::V3, "LorebookEntry".into()));
            }
        }

        Ok(())
    }
}

impl From<CharacterCard> for NestedCharacterCard {
    fn from(value: CharacterCard) -> Self {
        let v1 = match value {
            CharacterCard::Flat(v1) => v1,
            CharacterCard::Nested(nested) => return nested,
        };

        Self {
            spec: Version::V1.name().unwrap().into(),
            spec_version: Version::V1,
            data: CharacterCardData {
                v1,
                v2: None.into(),
                v3: None.into(),
            },
        }
    }
}

/// Represents character card data regardless of specification version.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct CharacterCardData {
    /// Represents version-1-specific data.
    #[serde(flatten)]
    pub v1: v1::CharacterCardData,

    /// Represents version-2-specific data.
    ///
    /// For version 2 or later, it's ensured that this field is not `None`.
    #[serde(with = "version_specific")]
    #[serde(flatten)]
    pub v2: Option<v2::CharacterCardData>,

    /// Represents version-3-specific data.
    ///
    /// For version 3 or later, it's ensured that this field is not `None`.
    #[serde(with = "version_specific")]
    #[serde(flatten)]
    pub v3: Option<v3::CharacterCardData>,
}

/// Represents lorebook regardless of specification version.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Lorebook {
    /// Represents version-2-specific data.
    #[serde(flatten)]
    v2: v2::Lorebook,
}

/// Represents lorebook entry regardless of specification version.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct LorebookEntry {
    /// Represents version-2-specific data.
    #[serde(flatten)]
    v2: v2::LorebookEntry,

    /// Represents version-3-specific data.
    #[serde(with = "version_specific")]
    #[serde(flatten)]
    v3: Option<v3::LorebookEntry>,
}