term-data-table 0.2.3

Tables to render data in CLI apps
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
use crate::{Cell, Row};
use anyhow::anyhow;
use serde::{ser, Serialize};
use std::fmt;

type Result<T, E = Error> = std::result::Result<T, E>;
pub struct Error(anyhow::Error);

impl Error {
    fn from(e: impl std::error::Error + Send + Sync + 'static) -> Self {
        Self(anyhow::Error::from(e))
    }
}

impl fmt::Debug for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Debug::fmt(&self.0, f)
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Display::fmt(&self.0, f)
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        self.0.source()
    }
}

impl serde::ser::Error for Error {
    fn custom<T>(msg: T) -> Self
    where
        T: fmt::Display,
    {
        Error(anyhow!("{}", msg))
    }
}

pub fn serialize_row(value: impl Serialize) -> Result<Row<'static>> {
    let mut serializer = Serializer {
        row: Row::new(),
        level: 0,
    };
    value.serialize(&mut serializer)?;
    Ok(serializer.row)
}

pub struct Serializer {
    row: Row<'static>,
    level: usize,
}

impl Serializer {
    fn serialize_static_str(&mut self, s: &'static str) -> Result<()> {
        self.row.add_cell(Cell::from(s));
        Ok(())
    }

    fn serialize_string(&mut self, s: String) -> Result<()> {
        self.row.add_cell(Cell::from(s));
        Ok(())
    }
}

impl<'a> ser::Serializer for &'a mut Serializer {
    type Ok = ();
    type Error = Error;

    type SerializeSeq = SerializerSeq<'a>;
    type SerializeTuple = SerializerSeq<'a>;
    type SerializeTupleStruct = SerializerSeq<'a>;
    type SerializeTupleVariant = SerializerSeq<'a>;
    type SerializeMap = SerializerSeq<'a>;
    type SerializeStruct = SerializerSeq<'a>;
    type SerializeStructVariant = SerializerSeq<'a>;

    // Here we go with the simple methods. The following 12 methods receive one
    // of the primitive types of the data model and map it to JSON by appending
    // into the output string.
    fn serialize_bool(self, v: bool) -> Result<()> {
        self.serialize_static_str(if v { "true" } else { "false" })
    }

    fn serialize_i8(self, v: i8) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    fn serialize_i16(self, v: i16) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    fn serialize_i32(self, v: i32) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    // Not particularly efficient but this is example code anyway. A more
    // performant approach would be to use the `itoa` crate.
    fn serialize_i64(self, v: i64) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    fn serialize_u8(self, v: u8) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    fn serialize_u16(self, v: u16) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    fn serialize_u32(self, v: u32) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    fn serialize_u64(self, v: u64) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    fn serialize_f32(self, v: f32) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    fn serialize_f64(self, v: f64) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    fn serialize_char(self, v: char) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    // We can't rely on this being a static string
    fn serialize_str(self, v: &str) -> Result<()> {
        self.serialize_string(v.to_string())
    }

    fn serialize_bytes(self, v: &[u8]) -> Result<()> {
        let v = format!("{:?}", v);
        self.serialize_string(v)
    }

    fn serialize_none(self) -> Result<()> {
        self.serialize_static_str("")
    }

    fn serialize_some<T>(self, value: &T) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        value.serialize(self)
    }

    fn serialize_unit(self) -> Result<()> {
        // Skip field
        Ok(())
    }

    fn serialize_unit_struct(self, _name: &'static str) -> Result<()> {
        self.serialize_unit()
    }

    fn serialize_unit_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        variant: &'static str,
    ) -> Result<()> {
        self.serialize_static_str(variant)
    }

    fn serialize_newtype_struct<T>(self, _name: &'static str, value: &T) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        value.serialize(self)
    }

    fn serialize_newtype_variant<T>(
        self,
        _name: &'static str,
        _variant_index: u32,
        variant: &'static str,
        value: &T,
    ) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        let value = serde_json::to_string(value).map_err(|e| Error(e.into()))?;
        let output = format!("{}: {}", variant, value);
        self.serialize_string(output)
    }

    fn serialize_seq(self, _len: Option<usize>) -> Result<Self::SerializeSeq> {
        Ok(SerializerSeq::new("", BracketTy::Square, self))
    }

    fn serialize_tuple(self, _len: usize) -> Result<Self::SerializeTuple> {
        Ok(SerializerSeq::new("", BracketTy::Round, self))
    }

    // Tuple structs look just like sequences in JSON.
    fn serialize_tuple_struct(
        self,
        name: &'static str,
        _len: usize,
    ) -> Result<Self::SerializeTupleStruct> {
        Ok(SerializerSeq::new(name, BracketTy::Round, self))
    }

    // Tuple variants are represented in JSON as `{ NAME: [DATA...] }`. Again
    // this method is only responsible for the externally tagged representation.
    fn serialize_tuple_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        variant: &'static str,
        _len: usize,
    ) -> Result<Self::SerializeTupleVariant> {
        Ok(SerializerSeq::new(variant, BracketTy::Round, self))
    }

    // Maps are represented in JSON as `{ K: V, K: V, ... }`.
    fn serialize_map(self, _len: Option<usize>) -> Result<Self::SerializeMap> {
        Ok(SerializerSeq::new("", BracketTy::Curly, self))
    }

    // Structs look just like maps in JSON. In particular, JSON requires that we
    // serialize the field names of the struct. Other formats may be able to
    // omit the field names when serializing structs because the corresponding
    // Deserialize implementation is required to know what the keys are without
    // looking at the serialized data.
    fn serialize_struct(self, name: &'static str, _len: usize) -> Result<Self::SerializeStruct> {
        Ok(SerializerSeq::new(name, BracketTy::Curly, self))
    }

    // Struct variants are represented in JSON as `{ NAME: { K: V, ... } }`.
    // This is the externally tagged representation.
    fn serialize_struct_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        variant: &'static str,
        _len: usize,
    ) -> Result<Self::SerializeStructVariant> {
        Ok(SerializerSeq::new(variant, BracketTy::Curly, self))
    }
}

#[derive(Copy, Clone)]
enum BracketTy {
    Round,
    Curly,
    Square,
}

impl BracketTy {
    fn start(self) -> char {
        use BracketTy::*;
        match self {
            Round => '(',
            Curly => '{',
            Square => '[',
        }
    }

    fn end(self) -> char {
        use BracketTy::*;
        match self {
            Round => ')',
            Curly => '}',
            Square => ']',
        }
    }
}

pub struct SerializerSeq<'a> {
    ty: BracketTy,
    parent: &'a mut Serializer,
    output: String,
}

impl<'a> SerializerSeq<'a> {
    fn new(prefix: &'static str, ty: BracketTy, parent: &'a mut Serializer) -> Self {
        parent.level += 1;
        Self {
            ty,
            parent,
            output: if prefix.is_empty() {
                format!("{}", ty.start())
            } else {
                format!("{} {}", prefix, ty.start())
            },
        }
    }

    fn serialize_element<T>(&mut self, key: Option<&'static str>, value: &T) -> Result<()>
    where
        T: Serialize + ?Sized,
    {
        if self.parent.level > 1 {
            if !self.output.ends_with(self.ty.start()) {
                self.output += ", ";
            }
            if let Some(key) = key {
                self.output += &serde_json::to_string(key).map_err(Error::from)?;
                self.output += ": ";
            }
            self.output += &serde_json::to_string(value).map_err(Error::from)?;
        } else {
            value.serialize(&mut *self.parent)?;
        }
        Ok(())
    }

    fn end(mut self) -> Result<()> {
        self.parent.level -= 1;
        if self.parent.level > 0 {
            self.output.push(self.ty.end());
            self.parent.serialize_string(self.output)?;
        }
        Ok(())
    }
}

impl<'a> ser::SerializeSeq for SerializerSeq<'a> {
    type Ok = ();
    type Error = Error;

    // Serialize a single element of the sequence.
    fn serialize_element<T>(&mut self, value: &T) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        self.serialize_element(None, value)
    }

    // Close the sequence.
    fn end(self) -> Result<()> {
        self.end()
    }
}

impl<'a> ser::SerializeTuple for SerializerSeq<'a> {
    type Ok = ();
    type Error = Error;

    fn serialize_element<T>(&mut self, value: &T) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        self.serialize_element(None, value)
    }

    fn end(self) -> Result<()> {
        self.end()
    }
}

impl<'a> ser::SerializeTupleStruct for SerializerSeq<'a> {
    type Ok = ();
    type Error = Error;

    fn serialize_field<T>(&mut self, value: &T) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        self.serialize_element(None, value)
    }

    fn end(self) -> Result<()> {
        self.end()
    }
}

impl<'a> ser::SerializeTupleVariant for SerializerSeq<'a> {
    type Ok = ();
    type Error = Error;

    fn serialize_field<T>(&mut self, value: &T) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        self.serialize_element(None, value)
    }

    fn end(self) -> Result<()> {
        self.end()
    }
}

impl<'a> ser::SerializeMap for SerializerSeq<'a> {
    type Ok = ();
    type Error = Error;

    fn serialize_key<T>(&mut self, key: &T) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        if self.parent.level > 1 {
            if !self.output.ends_with(self.ty.start()) {
                self.output += ", ";
            }
            self.output += &serde_json::to_string(key).map_err(Error::from)?;
            self.output += ": ";
        } else {
            // serialize nothing
        }
        Ok(())
    }

    fn serialize_value<T>(&mut self, value: &T) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        if self.parent.level > 1 {
            self.output += &serde_json::to_string(value).map_err(Error::from)?;
        } else {
            value.serialize(&mut *self.parent)?;
        }
        Ok(())
    }

    fn end(self) -> Result<()> {
        self.end()
    }
}

// Structs are like maps in which the keys are constrained to be compile-time
// constant strings.
impl<'a> ser::SerializeStruct for SerializerSeq<'a> {
    type Ok = ();
    type Error = Error;

    fn serialize_field<T>(&mut self, key: &'static str, value: &T) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        self.serialize_element(Some(key), value)
    }

    fn end(self) -> Result<()> {
        self.end()
    }
}

// Similar to `SerializeTupleVariant`, here the `end` method is responsible for
// closing both of the curly braces opened by `serialize_struct_variant`.
impl<'a> ser::SerializeStructVariant for SerializerSeq<'a> {
    type Ok = ();
    type Error = Error;

    fn serialize_field<T>(&mut self, key: &'static str, value: &T) -> Result<()>
    where
        T: ?Sized + Serialize,
    {
        self.serialize_element(Some(key), value)
    }

    fn end(self) -> Result<()> {
        self.end()
    }
}