lusl 2.1.0

Lossless Uncompressed Serializer 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

//! Version module.
//!
//! This module contains the version struct and functions to get the current version of the library.
//! The version is stored in the header of the serialized file.
//! The version is also used to check if the serialized file is compatible with the current library.
//! The version is stored in the following format:
//! - Version start flag: 1 byte
//! - Major version: 1 byte
//! - Minor version: 1 byte
//! - Patch version: 1 byte
//!

use core::fmt;
use std::io;

const MAJOR_VERSION: &str = env!("CARGO_PKG_VERSION_MAJOR");
const MINOR_VERSION: &str = env!("CARGO_PKG_VERSION_MINOR");
const PATCH_VERSION: &str = env!("CARGO_PKG_VERSION_PATCH");

/// Get the current major version of the library.
pub fn get_major_version() -> u8 {
    MAJOR_VERSION.parse().unwrap_or_default()
}

/// Get the current minor version of the library.
pub fn get_minor_version() -> u8 {
    MINOR_VERSION.parse().unwrap_or_default()
}

/// Get the current patch version of the library.
pub fn get_patch_version() -> u8 {
    PATCH_VERSION.parse().unwrap_or_default()
}

/// Version struct.
///
/// This struct is used to store the version of the serialized file or library.
/// The version is stored in the header of the serialized file.
/// The version is also used to check if the serialized file is compatible with the current library.
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct Version {
    major: u8,
    minor: u8,
    patch: u8,
}

impl Version {
    /// Create a new version.
    pub fn new(major: u8, minor: u8, patch: u8) -> Self {
        Version {
            major,
            minor,
            patch,
        }
    }

    /// Get the major version.
    pub fn major(&self) -> u8 {
        self.major
    }

    /// Get the minor version.
    pub fn minor(&self) -> u8 {
        self.minor
    }

    /// Get the patch version.
    pub fn patch(&self) -> u8 {
        self.patch
    }

    pub fn from_bytes(bytes: &[u8]) -> io::Result<Self> {
        if bytes.len() < 3 {
            return Err(io::Error::new(
                io::ErrorKind::InvalidData,
                "Invalid version bytes.",
            ));
        }
        Ok(Version {
            major: bytes[0],
            minor: bytes[1],
            patch: bytes[2],
        })
    }
    pub fn to_bytes(&self) -> [u8; 3] {
        [self.major, self.minor, self.patch]
    }
}

impl Default for Version {
    fn default() -> Self {
        Version::new(
            get_major_version(),
            get_minor_version(),
            get_patch_version(),
        )
    }
}

impl fmt::Display for Version {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}.{}.{}", self.major, self.minor, self.patch)
    }
}