cdr 0.2.4

A serialization/deserialization implementation of Common Data Representation
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

//! A serialization/deserialization implementation for Common Data Representation.
//!
//! # Examples
//!
//! ```rust
//! use cdr::{CdrBe, Infinite};
//! use serde_derive::{Deserialize, Serialize};
//!
//! #[derive(Deserialize, Serialize, PartialEq)]
//! struct Point {
//!     x: f64,
//!     y: f64,
//! }
//!
//! #[derive(Deserialize, Serialize, PartialEq)]
//! struct Polygon(Vec<Point>);
//!
//! fn main() {
//!     let triangle = Polygon(vec![Point { x: -1.0, y: -1.0 },
//!                                 Point { x: 1.0, y: -1.0 },
//!                                 Point { x: 0.0, y: 0.73 }]);
//!
//!     let encoded = cdr::serialize::<_, _, CdrBe>(&triangle, Infinite).unwrap();
//!     let decoded = cdr::deserialize::<Polygon>(&encoded[..]).unwrap();
//!
//!     assert!(triangle == decoded);
//! }
//! ```

pub use byteorder::{BigEndian, LittleEndian};

pub mod de;
#[doc(inline)]
pub use crate::de::Deserializer;

mod encapsulation;
pub use crate::encapsulation::{CdrBe, CdrLe, Encapsulation, PlCdrBe, PlCdrLe};

mod error;
pub use crate::error::{Error, Result};

pub mod ser;
#[doc(inline)]
pub use crate::ser::Serializer;

pub mod size;
#[doc(inline)]
pub use crate::size::{Bounded, Infinite, SizeLimit};

use std::io::{Read, Write};

/// Returns the size that an object would be if serialized with a encapsulation.
pub fn calc_serialized_size<T: ?Sized>(value: &T) -> u64
where
    T: serde::Serialize,
{
    size::calc_serialized_data_size(value) + encapsulation::ENCAPSULATION_HEADER_SIZE
}

/// Given a maximum size limit, check how large an object would be if it were
/// to be serialized with a encapsulation.
pub fn calc_serialized_size_bounded<T: ?Sized>(value: &T, max: u64) -> Result<u64>
where
    T: serde::Serialize,
{
    use crate::encapsulation::ENCAPSULATION_HEADER_SIZE;

    if max < ENCAPSULATION_HEADER_SIZE {
        Err(Error::SizeLimit)
    } else {
        size::calc_serialized_data_size_bounded(value, max)
            .map(|size| size + ENCAPSULATION_HEADER_SIZE)
    }
}

/// Serializes a serializable object into a `Vec` of bytes with the encapsulation.
pub fn serialize<T: ?Sized, S, C>(value: &T, size_limit: S) -> Result<Vec<u8>>
where
    T: serde::Serialize,
    S: SizeLimit,
    C: Encapsulation,
{
    let mut writer = match size_limit.limit() {
        Some(limit) => {
            let actual_size = calc_serialized_size_bounded(value, limit)?;
            Vec::with_capacity(actual_size as usize)
        }
        None => {
            let size = calc_serialized_size(value) as usize;
            Vec::with_capacity(size)
        }
    };

    serialize_into::<_, _, _, C>(&mut writer, value, Infinite)?;
    Ok(writer)
}

/// Serializes an object directly into a `Write` with the encapsulation.
pub fn serialize_into<W, T: ?Sized, S, C>(writer: W, value: &T, size_limit: S) -> Result<()>
where
    W: Write,
    T: serde::ser::Serialize,
    S: SizeLimit,
    C: Encapsulation,
{
    if let Some(limit) = size_limit.limit() {
        calc_serialized_size_bounded(value, limit)?;
    }

    let mut serializer = Serializer::<_, C::E>::new(writer);

    serde::Serialize::serialize(&C::id(), &mut serializer)?;
    serde::Serialize::serialize(&C::option(), &mut serializer)?;
    serializer.reset_pos();
    serde::Serialize::serialize(value, &mut serializer)
}

/// Deserializes a slice of bytes into an object.
pub fn deserialize<'de, T>(bytes: &[u8]) -> Result<T>
where
    T: serde::Deserialize<'de>,
{
    deserialize_from::<_, _, _>(bytes, Infinite)
}

/// Deserializes an object directly from a `Read`.
pub fn deserialize_from<'de, R, T, S>(reader: R, size_limit: S) -> Result<T>
where
    R: Read,
    T: serde::Deserialize<'de>,
    S: SizeLimit,
{
    use crate::encapsulation::ENCAPSULATION_HEADER_SIZE;

    let mut deserializer = Deserializer::<_, S, BigEndian>::new(reader, size_limit);

    let v: [u8; ENCAPSULATION_HEADER_SIZE as usize] =
        serde::Deserialize::deserialize(&mut deserializer)?;
    deserializer.reset_pos();
    match v[1] {
        0 | 2 => serde::Deserialize::deserialize(&mut deserializer),
        1 | 3 => serde::Deserialize::deserialize(
            &mut Into::<Deserializer<_, _, LittleEndian>>::into(deserializer),
        ),
        _ => Err(Error::InvalidEncapsulation),
    }
}