serde-gff 0.3.0

https://github.com/Mingun/serde-gff
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

//! Содержит описания значений, которые может хранить GFF файл

use indexmap::IndexMap;

use crate::{Label, LocString, ResRef};
use crate::index::{U64Index, I64Index, F64Index, StringIndex, ResRefIndex, LocStringIndex, BinaryIndex};

/// Перечисление, представляющее все примитивные типы данных, который может хранить GFF файл.
///
/// Кроме примитивных типов данных GFF файл также может хранить рекурсивные структуры из
/// данных типов и их списки.
#[derive(Debug, Clone, PartialEq)]
pub enum SimpleValueRef {
  /// Беззнаковое байтовое значение (от 0 до 255), занимающее один байт.
  ///
  /// Тег, ассоциированный с типом, равен `0`.
  Byte(u8),
  /// Символ текста в диапазоне `0x00-0xFF`, занимающий один байт.
  ///
  /// Тег, ассоциированный с типом, равен `1`.
  Char(i8),
  /// Беззнаковое целое (от 0 до 65535), занимающее 2 байта.
  ///
  /// Тег, ассоциированный с типом, равен `2`.
  Word(u16),
  /// Знаковое целое (от -32768 до 32767), занимающее 2 байта.
  ///
  /// Тег, ассоциированный с типом, равен `3`.
  Short(i16),
  /// Беззнаковое целое (от 0 до 4294967296), занимающее 4 байта.
  ///
  /// Тег, ассоциированный с типом, равен `4`.
  Dword(u32),
  /// Знаковое целое (от -2147483648 до 2147483647), занимающее 4 байта.
  ///
  /// Тег, ассоциированный с типом, равен `5`.
  Int(i32),
  /// Беззнаковое целое (от 0 до примерно 18e+18), занимающее 8 байт.
  ///
  /// Тег, ассоциированный с типом, равен `6`.
  Dword64(U64Index),
  /// Знаковое целое (примерно от -9e+18 до +9e+18), занимающее 8 байт.
  ///
  /// Тег, ассоциированный с типом, равен `7`.
  Int64(I64Index),
  /// Число с плавающей запятой одинарной точности, занимающее 4 байта.
  ///
  /// Тег, ассоциированный с типом, равен `8`.
  Float(f32),
  /// Число с плавающей запятой двойной точности, занимающее 8 байт.
  ///
  /// Тег, ассоциированный с типом, равен `9`.
  Double(F64Index),
  /// Нелокализуемая строка.
  ///
  /// Предпочитаемый максимальный размер - 1024 символа. Это ограничение установлено в первую
  /// очередь для того, чтобы сохранить пропускную способность сети в том случае, если строку
  /// необходимо передавать с сервера на клиент.
  ///
  /// Данный вид строк не должен использоваться для текста, который может увидеть игрок, так как
  /// он будет одинаковым независимо от языка клиента игры. Область применения данного типа -
  /// текст для разработчиков/дизайнеров уровней, например, тегов объектов, используемых в скриптах.
  ///
  /// Тег, ассоциированный с типом, равен `10`.
  String(StringIndex),
  /// Имя файла ресурса, до 16 символов.
  ///
  /// Тег, ассоциированный с типом, равен `11`.
  ResRef(ResRefIndex),
  /// Локализуемая строка. Содержит `StringRef` и несколько `CExoString`, каждую со своим номером языка.
  ///
  /// Тег, ассоциированный с типом, равен `12`.
  LocString(LocStringIndex),
  /// Произвольные данные любой длины.
  ///
  /// Тег, ассоциированный с типом, равен `13`.
  Void(BinaryIndex),
}

/// Перечисление, представляющее все примитивные типы данных, который может хранить GFF файл.
/// В отличие от [`SimpleValueRef`] содержит полностью прочитанные данные из файла, а не только
/// ссылки на них
///
/// Кроме примитивных типов данных GFF файл также может хранить рекурсивные структуры из
/// данных типов и их списки.
///
/// [`SimpleValueRef`]: enum.SimpleValueRef.html
#[derive(Debug, Clone, PartialEq)]
pub enum SimpleValue {
  /// Беззнаковое байтовое значение (от 0 до 255), занимающее один байт.
  ///
  /// Тег, ассоциированный с типом, равен `0`.
  Byte(u8),
  /// Символ текста в диапазоне `0x00-0xFF`, занимающий один байт.
  ///
  /// Тег, ассоциированный с типом, равен `1`.
  Char(i8),
  /// Беззнаковое целое (от 0 до 65535), занимающее 2 байта.
  ///
  /// Тег, ассоциированный с типом, равен `2`.
  Word(u16),
  /// Знаковое целое (от -32768 до 32767), занимающее 2 байта.
  ///
  /// Тег, ассоциированный с типом, равен `3`.
  Short(i16),
  /// Беззнаковое целое (от 0 до 4294967296), занимающее 4 байта.
  ///
  /// Тег, ассоциированный с типом, равен `4`.
  Dword(u32),
  /// Знаковое целое (от -2147483648 до 2147483647), занимающее 4 байта.
  ///
  /// Тег, ассоциированный с типом, равен `5`.
  Int(i32),
  /// Беззнаковое целое (от 0 до примерно 18e+18), занимающее 8 байт.
  ///
  /// Тег, ассоциированный с типом, равен `6`.
  Dword64(u64),
  /// Знаковое целое (примерно от -9e+18 до +9e+18), занимающее 8 байт.
  ///
  /// Тег, ассоциированный с типом, равен `7`.
  Int64(i64),
  /// Число с плавающей запятой одинарной точности, занимающее 4 байта.
  ///
  /// Тег, ассоциированный с типом, равен `8`.
  Float(f32),
  /// Число с плавающей запятой двойной точности, занимающее 8 байт.
  ///
  /// Тег, ассоциированный с типом, равен `9`.
  Double(f64),
  /// Нелокализуемая строка.
  ///
  /// Предпочитаемый максимальный размер - 1024 символа. Это ограничение установлено в первую
  /// очередь для того, чтобы сохранить пропускную способность сети в том случае, если строку
  /// необходимо передавать с сервера на клиент.
  ///
  /// Данный вид строк не должен использоваться для текста, который может увидеть игрок, так как
  /// он будет одинаковым независимо от языка клиента игры. Область применения данного типа -
  /// текст для разработчиков/дизайнеров уровней, например, тегов объектов, используемых в скриптах.
  ///
  /// Тег, ассоциированный с типом, равен `10`.
  String(String),
  /// Имя файла ресурса, до 16 символов.
  ///
  /// Тег, ассоциированный с типом, равен `11`.
  ResRef(ResRef),
  /// Локализуемая строка. Содержит `StringRef` и несколько `CExoString`, каждую со своим номером языка.
  ///
  /// Тег, ассоциированный с типом, равен `12`.
  LocString(LocString),
  /// Произвольные данные любой длины.
  ///
  /// Тег, ассоциированный с типом, равен `13`.
  Void(Vec<u8>),
}

/// Перечисление, представляющее все возможные типы данных, которых способен хранить GFF файл,
/// в обобщенном виде. Аналог `serde_json::Value`
#[derive(Debug, Clone, PartialEq)]
pub enum Value {
  /// Беззнаковое байтовое значение (от 0 до 255), занимающее один байт.
  ///
  /// Тег, ассоциированный с типом, равен `0`.
  Byte(u8),
  /// Символ текста в диапазоне `0x00-0xFF`, занимающий один байт.
  ///
  /// Тег, ассоциированный с типом, равен `1`.
  Char(i8),
  /// Беззнаковое целое (от 0 до 65535), занимающее 2 байта.
  ///
  /// Тег, ассоциированный с типом, равен `2`.
  Word(u16),
  /// Знаковое целое (от -32768 до 32767), занимающее 2 байта.
  ///
  /// Тег, ассоциированный с типом, равен `3`.
  Short(i16),
  /// Беззнаковое целое (от 0 до 4294967296), занимающее 4 байта.
  ///
  /// Тег, ассоциированный с типом, равен `4`.
  Dword(u32),
  /// Знаковое целое (от -2147483648 до 2147483647), занимающее 4 байта.
  ///
  /// Тег, ассоциированный с типом, равен `5`.
  Int(i32),
  /// Беззнаковое целое (от 0 до примерно 18e+18), занимающее 8 байт.
  ///
  /// Тег, ассоциированный с типом, равен `6`.
  Dword64(u64),
  /// Знаковое целое (примерно от -9e+18 до +9e+18), занимающее 8 байт.
  ///
  /// Тег, ассоциированный с типом, равен `7`.
  Int64(i64),
  /// Число с плавающей запятой одинарной точности, занимающее 4 байта.
  ///
  /// Тег, ассоциированный с типом, равен `8`.
  Float(f32),
  /// Число с плавающей запятой двойной точности, занимающее 8 байт.
  ///
  /// Тег, ассоциированный с типом, равен `9`.
  Double(f64),
  /// Нелокализуемая строка.
  ///
  /// Предпочитаемый максимальный размер - 1024 символа. Это ограничение установлено в первую
  /// очередь для того, чтобы сохранить пропускную способность сети в том случае, если строку
  /// необходимо передавать с сервера на клиент.
  ///
  /// Данный вид строк не должен использоваться для текста, который может увидеть игрок, так как
  /// он будет одинаковым независимо от языка клиента игры. Область применения данного типа -
  /// текст для разработчиков/дизайнеров уровней, например, тегов объектов, используемых в скриптах.
  ///
  /// Тег, ассоциированный с типом, равен `10`.
  String(String),
  /// Имя файла ресурса, до 16 символов.
  ///
  /// Тег, ассоциированный с типом, равен `11`.
  ResRef(ResRef),
  /// Локализуемая строка. Содержит `StringRef` и несколько `CExoString`, каждую со своим номером языка.
  ///
  /// Тег, ассоциированный с типом, равен `12`.
  LocString(LocString),
  /// Произвольные данные любой длины.
  ///
  /// Тег, ассоциированный с типом, равен `13`.
  Void(Vec<u8>),
  /// Вложенная структура. Порядок полей в структуре постоянный и определяется порядком их добавления
  ///
  /// Тег, ассоциированный с типом, равен `14`.
  Struct(IndexMap<Label, Value>),
  /// Список значений любой длины.
  ///
  /// Тег, ассоциированный с типом, равен `15`.
  List(Vec<Value>),
}

impl From<SimpleValue> for Value {
  #[inline]
  fn from(value: SimpleValue) -> Value {
    use self::SimpleValue::*;

    match value {
      Byte(val)      => Value::Byte(val),
      Char(val)      => Value::Char(val),
      Word(val)      => Value::Word(val),
      Short(val)     => Value::Short(val),
      Dword(val)     => Value::Dword(val),
      Int(val)       => Value::Int(val),
      Dword64(val)   => Value::Dword64(val),
      Int64(val)     => Value::Int64(val),
      Float(val)     => Value::Float(val),
      Double(val)    => Value::Double(val),
      String(val)    => Value::String(val),
      ResRef(val)    => Value::ResRef(val),
      LocString(val) => Value::LocString(val),
      Void(val)      => Value::Void(val),
    }
  }
}