jppe 1.1.1

This is a byte stream structured serialization and deserialization library.
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

//!
//! ```
//! use jppe::{ByteEncode, ByteDecode};
//! use jppe_derive::{ByteEncode, ByteDecode};
//!
//!
//! #[derive(Debug, PartialEq, Eq, ByteEncode, ByteDecode)]
//! pub struct SimpleExample {
//!     pub length: u16,
//!     #[jppe(length="length")]
//!     pub value: String,
//!     pub cmd: u8,
//!     #[jppe(branch="cmd")]
//!     pub body: SimpleExampleBody,
//! }
//! 
//! 
//! #[derive(Debug, PartialEq, Eq, ByteEncode, ByteDecode)]
//! #[repr(u8)]
//! pub enum SimpleExampleBody {
//!     Read {
//!         address: u8,
//!     } = 1,
//!     Write {
//!         address: u8,
//!         value: [u8; 3],
//!     },
//!     #[jppe(enum_default)]
//!     Unknown, 
//! }
//! 
//! 
//! fn main() {
//!     let input = b"\x00\x03\x31\x32\x33\x01\x05";
//!     let (input_remain, value) = jppe::decode::<SimpleExample>(input).unwrap();
//!     assert_eq!(value, SimpleExample { length: 3, value: "123".to_string(), cmd: 1, body: SimpleExampleBody::Read { address: 5 } });
//!     assert_eq!(input_remain.is_empty(), true);
//!     assert_eq!(jppe::encode(value), input);
//! }
//! ```
#![cfg_attr(not(feature = "std"), no_std)]

#[cfg(not(feature = "std"))]
extern crate alloc;

#[cfg(feature = "jppe_derive")]
extern crate jppe_derive;
#[cfg(feature = "jppe_derive")]
pub use jppe_derive::{ByteDecode, ByteEncode, BorrowByteDecode, BorrowByteEncode};

#[cfg(feature = "jget")]
extern crate jget;
#[cfg(feature = "jget")]
pub use jget::Jget;

#[cfg(feature = "jdefault_derive")]
extern crate jdefault_derive;
#[cfg(feature = "jdefault_derive")]
pub use jdefault_derive::Jdefault;

#[cfg(not(feature = "std"))]
use alloc::{
    vec::Vec,
};


mod decode;
mod encode;
mod parser;
pub mod fields;
mod byteorder;
mod modifiers;
mod input;
mod std;

pub use byteorder::ByteOrder;
pub use decode::*;
pub use encode::*;
pub use parser::*;
pub use modifiers::*;
pub use input::*;

pub mod prelude {
    pub use jkcenum::FromInt;
    pub use crate::std::FromStr;
    pub use crate::parser::*;
    pub use crate::byteorder::ByteOrder;
    // pub use crate::decode::*;
    // pub use crate::encode::*;
    pub use crate::fields::*;
    pub use crate::modifiers::*;
    pub use crate::input::*;
    pub use crate::{encode, decode};
}


/// Decode byte stream
/// 
/// # Examples:
/// 
/// ```
/// 
/// use jppe_derive::{ByteDecode};
/// 
/// #[derive(Debug, PartialEq, Eq, ByteDecode)]
/// pub struct SimpleExample {
///     pub length: u8,
///     #[jppe(length="length")]
///     pub data: String,
/// }
/// let (input, value) = jppe::decode::<SimpleExample>(b"\x02\x31\x32").unwrap();
/// assert_eq!(value, SimpleExample { length: 2, data: "12".to_string() });
/// assert_eq!(input.is_empty(), true);
/// ```
#[inline]
pub fn decode<'a, T: ByteDecode>(input: &'a [u8]) -> JResult<&'a [u8], T> {
    T::decode(input, None, None)
}


/// Encode byte stream
/// 
/// # Examples:
/// 
/// ```
/// 
/// use jppe_derive::{ByteEncode};
/// 
/// #[derive(Debug, PartialEq, Eq, ByteEncode)]
/// pub struct SimpleExample {
///     pub length: u8,
///     #[jppe(length="length")]
///     pub data: String,
/// }
/// let value = SimpleExample { length: 2, data: "12".to_string() };
/// assert_eq!(jppe::encode(value), b"\x02\x31\x32");
/// ```
#[inline]
pub fn encode<'a, T: ByteEncode>(t: T) -> Vec<u8> {
    let mut buf = Vec::new();

    t.encode(&mut buf, None, None);

    buf
}


/// Decode byte stream
/// 
/// # Examples:
/// 
/// ```
/// 
/// use jppe_derive::{BorrowByteDecode};
/// 
/// #[derive(Debug, PartialEq, Eq, BorrowByteDecode)]
/// pub struct SimpleExample<'a> {
///     pub length: u8,
///     #[jppe(length="length")]
///     pub data: &'a [u8],
/// }
/// let (input, value) = jppe::decode_borrow::<SimpleExample>(b"\x02\x03\x01").unwrap();
/// assert_eq!(value, SimpleExample { length: 2, data: b"\x03\x01" });
/// assert_eq!(input.is_empty(), true);
/// ```
#[inline]
pub fn decode_borrow<'a, T: BorrowByteDecode<'a>>(input: &'a [u8]) -> JResult<&'a [u8], T> {
    T::decode(input, None, None)
}


/// Encode byte stream
/// 
/// # Examples:
/// 
/// ```
/// 
/// use jppe_derive::{BorrowByteEncode};
/// 
/// #[derive(Debug, PartialEq, Eq, BorrowByteEncode)]
/// pub struct SimpleExample<'a> {
///     pub length: u8,
///     #[jppe(length="length")]
///     pub data: &'a [u8],
/// }
/// let value = SimpleExample { length: 2, data: b"12" };
/// assert_eq!(jppe::encode_borrow(value), b"\x02\x31\x32");
/// ```
#[inline]
pub fn encode_borrow<'a, T: BorrowByteEncode>(t: T) -> Vec<u8> {
    let mut buf = Vec::new();

    t.encode(&mut buf, None, None);

    buf
}