castflip 0.1.12

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

//!
//! Is a document folder.
//!
//! This module defines the hierarchy of the document tree.
//!

pub mod example1 {
    // 1. Basic Example: A `struct` type is encasted and decasted
    //    with its endianness flipped as required.
    #![doc = include_doc!("example1_basic_example.md")]
    use crate::*;
}

pub mod example2 {
    // 2. Nested Example: A nested `struct` type is encasted and decasted
    //    with its endianness flipped as required.
    #![doc = include_doc!("example2_nested_example.md")]
    use crate::*;
}

pub mod example3 {
    // 3. Arrayed Example: An array of a `struct` type is encasted and decasted
    //    with its endianness flipped as required.
    #![doc = include_doc!("example3_arrayed_example.md")]
    use crate::*;
}

pub mod example4 {
    // 4. I/O Example: A `struct` type is encasted and decasted
    //    with its endianness flipped as required
    //    using trait [`std::io::Read`] and trait [`std::io::Write`].
    #![doc = include_doc!("example4_using_std_io.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 Cast and Flip: `DecastMem` and `EncastMem`/
    //    `DecastIO` and `EncastIO`
    #![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::*;
}