endify 0.1.2

effortlessly convert structs between endian-formats.
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

//! # endify
//!
//! Effortlessly convert structs between endianess-formats.
//!
//! ## Usage
//! ```rust
//! use endify::Endify;
//!
//! #[repr(C)]
//! #[derive(Debug, Endify)]
//! struct MyStruct {
//!     a: u32,
//!     b: u16,
//!     c: u8,
//! }
//!
//! # fn read_from_disk() -> MyStruct {
//! #   MyStruct { a: 30u32.to_be(), b: 10u16.to_be(), c: 3u8.to_be() }
//! # }
//!
//! fn main() {
//!     // stored on disk as `little-endian` format.
//!     let my_struct = read_from_disk();
//!
//!     // convert all fields to `native-endian` format.
//!     let my_struct_native = my_struct.from_le();
//! }
//! ```

#![no_std]
#![allow(clippy::wrong_self_convention)]
pub use endify_derive::Endify;

/// A trait for converting between endianess-formts effortlessly.
pub trait Endify {
    /// Converts a struct to little-endian format.
    fn to_le(self) -> Self;
    /// Converts a struct to big-endian format.
    fn to_be(self) -> Self;
    /// Converts a struct stored in little-endian format to native-endian format.
    fn from_le(self) -> Self;
    /// Converts a struct stored in big-endian format to native-endian format.
    fn from_be(self) -> Self;
}

macro_rules! impl_noop {
    ($($t:ty),+) => {
        $(
        impl Endify for $t {
            fn to_le(self) -> Self {
                self
            }

            fn to_be(self) -> Self {
                self
            }

            fn from_le(self) -> Self {
                self
            }

            fn from_be(self) -> Self {
                self
            }
        }
        )+
    };
}

macro_rules! impl_primitive {
    ($($t:ty), +) => {
        $(
        impl Endify for $t {
            fn to_le(self) -> Self {
               <$t>::to_le(self)
            }

            fn to_be(self) -> Self {
                <$t>::to_be(self)
            }

            fn from_le(self) -> Self {
                <$t>::from_le(self)
            }

            fn from_be(self) -> Self {
                <$t>::from_be(self)
            }
        }
        )+
    };
}

impl<T: Endify, const N: usize> Endify for [T; N] {
    fn to_le(self) -> Self {
        self.map(Endify::to_le)
    }

    fn to_be(self) -> Self {
        self.map(Endify::to_be)
    }
    fn from_le(self) -> Self {
        self.map(Endify::from_le)
    }
    fn from_be(self) -> Self {
        self.map(Endify::from_be)
    }
}

impl_noop!(u8, i8, bool);
impl_primitive!(u16, i16, u32, i32, u64, i64, u128, i128);