xcassets 0.1.0

Parse Xcode .xcassets catalogs into a typed Rust tree with diagnostics.
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

use std::path::PathBuf;

use serde::{Deserialize, Serialize};
use serde_json::{Map, Value};

use crate::Diagnostic;

pub type JsonMap = Map<String, Value>;

#[derive(Debug, Clone, PartialEq)]
pub struct ParseReport {
    pub catalog: AssetCatalog,
    pub diagnostics: Vec<Diagnostic>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct AssetCatalog {
    pub name: String,
    pub source_path: PathBuf,
    pub files: Vec<PathBuf>,
    pub raw_contents: Option<RawContents>,
    pub contents: Option<FolderContents>,
    pub children: Vec<Node>,
}

#[derive(Debug, Clone, PartialEq)]
pub enum Node {
    Group(GroupNode),
    ImageSet(ImageSetNode),
    ColorSet(ColorSetNode),
    AppIconSet(AppIconSetNode),
    Opaque(OpaqueNode),
}

#[derive(Debug, Clone, PartialEq)]
pub struct FolderNode<T> {
    pub name: String,
    pub relative_path: PathBuf,
    pub files: Vec<PathBuf>,
    pub raw_contents: Option<RawContents>,
    pub contents: Option<T>,
    pub children: Vec<Node>,
}

pub type GroupNode = FolderNode<FolderContents>;
pub type ImageSetNode = FolderNode<ImageSetContents>;
pub type ColorSetNode = FolderNode<ColorSetContents>;
pub type AppIconSetNode = FolderNode<AppIconSetContents>;

#[derive(Debug, Clone, PartialEq)]
pub struct OpaqueNode {
    pub name: String,
    pub relative_path: PathBuf,
    pub folder_type: String,
    pub files: Vec<PathBuf>,
    pub raw_contents: Option<RawContents>,
    pub children: Vec<Node>,
}

#[derive(Debug, Clone, PartialEq)]
pub enum RawContents {
    Json(Value),
    InvalidJson(String),
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct FolderContents {
    pub info: Option<ContentsInfo>,
    #[serde(default)]
    pub properties: FolderProperties,
    #[serde(flatten, default)]
    pub extras: JsonMap,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct ImageSetContents {
    pub info: Option<ContentsInfo>,
    #[serde(default)]
    pub properties: FolderProperties,
    #[serde(default)]
    pub images: Vec<ImageEntry>,
    #[serde(flatten, default)]
    pub extras: JsonMap,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct ColorSetContents {
    pub info: Option<ContentsInfo>,
    #[serde(default)]
    pub properties: FolderProperties,
    #[serde(default)]
    pub colors: Vec<ColorEntry>,
    #[serde(flatten, default)]
    pub extras: JsonMap,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct AppIconSetContents {
    pub info: Option<ContentsInfo>,
    #[serde(default)]
    pub properties: FolderProperties,
    #[serde(default)]
    pub images: Vec<ImageEntry>,
    #[serde(flatten, default)]
    pub extras: JsonMap,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct ContentsInfo {
    pub author: Option<String>,
    pub version: Option<u64>,
    #[serde(flatten, default)]
    pub extras: JsonMap,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct FolderProperties {
    #[serde(rename = "provides-namespace")]
    pub provides_namespace: Option<bool>,
    pub localizable: Option<bool>,
    #[serde(rename = "template-rendering-intent")]
    pub template_rendering_intent: Option<String>,
    #[serde(flatten, default)]
    pub extras: JsonMap,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct ImageEntry {
    pub filename: Option<String>,
    pub idiom: Option<String>,
    pub scale: Option<String>,
    #[serde(rename = "language-direction")]
    pub language_direction: Option<String>,
    #[serde(rename = "display-gamut")]
    pub display_gamut: Option<String>,
    pub platform: Option<String>,
    pub size: Option<String>,
    pub role: Option<String>,
    pub subtype: Option<String>,
    #[serde(rename = "matching-style")]
    pub matching_style: Option<String>,
    pub memory: Option<String>,
    #[serde(rename = "graphics-feature-set")]
    pub graphics_feature_set: Option<String>,
    #[serde(rename = "screen-width")]
    pub screen_width: Option<String>,
    #[serde(rename = "width-class")]
    pub width_class: Option<String>,
    #[serde(rename = "height-class")]
    pub height_class: Option<String>,
    #[serde(default)]
    pub appearances: Vec<Appearance>,
    #[serde(flatten, default)]
    pub extras: JsonMap,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct ColorEntry {
    pub idiom: Option<String>,
    #[serde(rename = "display-gamut")]
    pub display_gamut: Option<String>,
    pub color: Option<ColorValue>,
    #[serde(default)]
    pub appearances: Vec<Appearance>,
    #[serde(flatten, default)]
    pub extras: JsonMap,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct Appearance {
    pub appearance: Option<String>,
    pub value: Option<String>,
    #[serde(flatten, default)]
    pub extras: JsonMap,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct ColorValue {
    #[serde(rename = "color-space")]
    pub color_space: Option<String>,
    #[serde(default)]
    pub components: JsonMap,
    #[serde(flatten, default)]
    pub extras: JsonMap,
}