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

//! `native_model` is a Rust crate that acts as a thin wrapper around serialized data, adding identity and version information.
//!
//! - It aims to ensure:
//!   - **Interoperability**: Different applications can work together even if they use different data model versions.
//!   - **Data Consistency**: Ensures the data is processed as expected.
//!   - **Flexibility**: Allows the use of any serialization format. Mode details [here](https://github.com/vincent-herlemont/native_model#setup-your-serialization-format).
//!   - **Minimal Performance Overhead**: Current performance has a minimal overhead see [performance](https://github.com/vincent-herlemont/native_model#performance) section.
//! - **Suitability**:
//!   - Suitable for applications that are written in Rust, evolve independently, store data locally, and require incremental upgrades.
//!   - Not suitable for non-Rust applications, systems not controlled by the user, or when human-readable formats are needed.
//! - **Setup**:
//!   - Users must define their own serialization format and data model. Mode details [here](https://github.com/vincent-herlemont/native_model#setup-your-serialization-format).
//! - **Development Stage**:
//!   - The crate is in early development, and performance is expected to improve over time.
//!
//! See examples in the [README.md](https://github.com/vincent-herlemont/native_model) file.

mod header;
mod model;
pub mod wrapper;

pub use model::*;

/// Macro to generate a [`native_model`] implementation for a struct.
pub use native_model_macro::*;

use wrapper::*;

use thiserror::Error;

pub type Result<T> = std::result::Result<T, Error>;

#[derive(Error, Debug)]
pub enum Error {
    #[error("Invalid header")]
    InvalidHeader,
    #[error("Failed to decode native model")]
    DecodeError,
    #[error(transparent)]
    DecodeBodyError(#[from] DecodeBodyError),
    #[error(transparent)]
    EncodeBodyError(#[from] EncodeBodyError),
    #[error(transparent)]
    UpgradeError(#[from] UpgradeError),
    #[error("Upgrade from {} to {} is not supported", from, to)]
    UpgradeNotSupported { from: u32, to: u32 },
    #[error(transparent)]
    DowngradeError(#[from] DowngradeError),
    #[error("Downgrade from {} to {} is not supported", from, to)]
    DowngradeNotSupported { from: u32, to: u32 },
    #[error("Wrong type id expected: {}, actual: {}", expected, actual)]
    WrongTypeId { expected: u32, actual: u32 },
}

pub type DecodeResult<T> = std::result::Result<T, DecodeBodyError>;

#[derive(Error, Debug)]
#[error("Decode body error: {msg}")]
pub enum DecodeBodyError {
    #[error("Mismatched model id")]
    MismatchedModelId,
    #[error("Decode error: {msg}")]
    DecodeError {
        msg: String,
        #[source]
        source: anyhow::Error,
    },
}

pub type EncodeResult<T> = std::result::Result<T, EncodeBodyError>;

#[derive(Error, Debug)]
#[error("Encode body error: {msg}")]
pub struct EncodeBodyError {
    pub msg: String,
    #[source]
    pub source: anyhow::Error,
}

#[derive(Error, Debug)]
#[error("Upgrade error: {msg}")]
pub struct UpgradeError {
    pub msg: String,
    #[source]
    pub source: anyhow::Error,
}

#[derive(Error, Debug)]
#[error("Downgrade error: {msg}")]
pub struct DowngradeError {
    pub msg: String,
    #[source]
    pub source: anyhow::Error,
}

/// Allows to encode a [`native_model`] into a [`Vec<u8>`].
///
/// See examples:
///    - [README.md](https://github.com/vincent-herlemont/native_model) file.
///    - other [examples](https://github.com/vincent-herlemont/native_model/tree/master/tests/example)
pub fn encode<T: Model>(model: &T) -> Result<Vec<u8>> {
    T::native_model_encode(model)
}

/// Allows to encode a [`native_model`] into a [`Vec<u8>`] with a specific version.
/// See examples:
///    - [README.md](https://github.com/vincent-herlemont/native_model) file.
///    - other [examples](https://github.com/vincent-herlemont/native_model/tree/master/tests/example)
pub fn encode_downgrade<T: Model>(model: T, version: u32) -> Result<Vec<u8>> {
    T::native_model_encode_downgrade(model, version)
}

/// Allows to decode a [`native_model`] from a [`Vec<u8>`] and returns the version ([`u32`]).
/// See examples:
///    - [README.md](https://github.com/vincent-herlemont/native_model) file.
///    - other [examples](https://github.com/vincent-herlemont/native_model/tree/master/tests/example)
pub fn decode<T: Model>(data: Vec<u8>) -> Result<(T, u32)> {
    T::native_model_decode(data)
}