castflip 0.1.15

Library for encoding/decoding numeric variables, arrays and structures in little-endian and big-endian
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

#![doc = include_doc!("documents.md")]

use crate::include_doc;

pub mod short_example1 {
    // 1. How to convert between bytes and a number
    #![doc = include_doc!("short_ex1_number.md")]
    use crate::*;
}

pub mod short_example2 {
    // 2. How to convert between bytes and an array of numbers
    #![doc = include_doc!("short_ex2_arrayed_numbers.md")]
    use crate::*;
}

pub mod short_example3 {
    // 3. How to convert between bytes and a `struct`
    #![doc = include_doc!("short_ex3_struct.md")]
    use crate::*;
}

pub mod short_example4 {
    // 4. How to convert between bytes and an array of a `struct`s
    #![doc = include_doc!("short_ex4_arrayed_structs.md")]
    use crate::*;
}

pub mod short_example5 {
    // 5. How to convert between bytes and nested `struct`s
    #![doc = include_doc!("short_ex5_nested_structs.md")]
    use crate::*;
}

pub mod long_example1 {
    // 1. How to convert between bytes and a `struct` (of the UDP header)
    #![doc = include_doc!("long_ex1_struct.md")]
    use crate::*;
}

pub mod long_example2 {
    // 2. How to convert between bytes and nested `struct`s
    #![doc = include_doc!("long_ex2_nested_structs.md")]
    use crate::*;
}

pub mod long_example3 {
    // 3. How to convert between bytes and an array of type `[T; N]`
    #![doc = include_doc!("long_ex3_array.md")]
    use crate::*;
}

pub mod long_example3_1 {
    // 3.1. As a value of type `[T; N]`
    #![doc = include_doc!("long_ex3_1_a_value.md")]
    use crate::*;
}

pub mod long_example3_2 {
    // 3.2. As N-consecutive values of type `T`
    #![doc = include_doc!("long_ex3_2_consecutive_values.md")]
    use crate::*;
}

pub mod long_example3_3 {
    // 3.3. As an element of slice `[[T; N]]`
    #![doc = include_doc!("long_ex3_3_a_slice_element.md")]
    use crate::*;
}

pub mod long_example4 {
    // 4. How to convert between bytes and a `struct` (of the UDP header)
    //    using `std::io`
    #![doc = include_doc!("long_ex4_std_io.md")]
    use crate::*;
}

pub mod long_example4_1 {
    // 4.1. Through a byte stream provided by struct [`std::io::Cursor`]
    #![doc = include_doc!("long_ex4_1_cursor.md")]
    use crate::*;
}

pub mod long_example4_2 {
    // 4.2. Through a byte stream provided by a mutable byte slice `&mut [u8]`
    #![doc = include_doc!("long_ex4_2_slice.md")]
    use crate::*;
}

pub mod summary1 {
    // 1. Enum Type: `Endian`
    #![doc = include_doc!("summary1_types.md")]
    use crate::*;
}

pub mod summary2 {
    // 2. Traits as Bounds: `Cast`, `Flip` and `NopFlip`
    #![doc = include_doc!("summary2_bounds.md")]
    use crate::*;
    use core::marker::PhantomData;
}

pub mod summary3 {
    // 3. Traits to Encast and Decast: `EncastMem` and `DecastMem` /
    //    `EncastIO` and `DecastIO`
    #![doc = include_doc!("summary3_traits.md")]
    use crate::*;
}

pub mod summary4 {
    // 4. Crate Features: `alloc` and `std`
    #![doc = include_doc!("summary4_features.md")]
    use crate::*;
}

pub mod summary5 {
    // 5. Planned Releases: Version 0.2 and 0.3
    #![doc = include_doc!("summary5_plans.md")]
    use crate::*;
    use core::marker::PhantomData;
}