minicbor 2.2.1

A small CBOR codec suitable for no_std environments.
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

//! Introspection utilities.

use crate::{BYTES, TEXT, ARRAY, MAP, SIMPLE, TAGGED, SIGNED, UNSIGNED, Decoder, data::Type};
use super::{decoder::{info_of, type_of}, Error};

/// Information about a CBOR item size.
///
/// # Usage example
///
/// ```rust
/// use minicbor::decode::info::Size;
///
/// let val  = vec![1, 2, 3, 4, 5];
/// let cbor = minicbor::to_vec(val)?;
/// let hlen = Size::head(cbor[0])?;
/// let size = Size::tail(&cbor[.. hlen])?;
/// assert_eq!(Size::Items(5), size);
/// # Ok::<_, Box<dyn core::error::Error>>(())
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Size {
    /// The item consists only of the head.
    Head,
    /// The item is some text or byte string with the given number of bytes.
    Bytes(u64),
    /// The item is an array or map with the given number of items.
    Items(u64),
    /// The item is an indefinite value.
    Indef
}

impl Size {
    /// Given the first byte, derive the length of the item head.
    pub fn head(fst: u8) -> Result<usize, Error> {
        match info_of(fst) {
            0 ..= 0x17 => Ok(1),
            0x18 => Ok(2),
            0x19 => Ok(3),
            0x1a => Ok(5),
            0x1b => Ok(9),
            0x1f => match type_of(fst) {
                BYTES | TEXT | ARRAY | MAP | SIMPLE => Ok(1),
                _ => Err(Error::message("invalid data item head"))
            }
            _ => Err(Error::message("invalid data item head"))
        }
    }

    /// Given the item head, derive the CBOR item's size information.
    pub fn tail(head: &[u8]) -> Result<Self, Error> {
        let fst = head.first().copied().ok_or_else(Error::end_of_input)?;
        match type_of(fst) {
            UNSIGNED | SIGNED | TAGGED | SIMPLE => Ok(Self::Head),
            BYTES | TEXT => match info_of(fst) {
                0x1f => Ok(Self::Indef),
                info => {
                    let mut d = Decoder::new(&head[1 ..]);
                    let p = d.position();
                    let n = d.unsigned(info, p)?;
                    Ok(Self::Bytes(n))
                }
            }
            ARRAY | MAP => match info_of(fst) {
                0x1f => Ok(Self::Indef),
                info => {
                    let mut d = Decoder::new(&head[1 ..]);
                    let p = d.position();
                    let n = d.unsigned(info, p)?;
                    Ok(Self::Items(n))
                }
            }
            n => {
                let t = Type::Unknown(n);
                Err(Error::type_mismatch(t).at(0).with_message("unknown cbor type"))
            }
        }
    }
}