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

Traits as Bounds: `Cast`, `Flip` and `NopFlip`

# Fundamental Bounds : `Cast` and `Flip`

Trait [`Cast`] and trait [`Flip`] are the fundamental traits of this
crate.

1. Trait [`Cast`] : The values of types implementing trait [`Cast`]
   can be encasted[^encast] and decasted[^decast] by the methods of
   this crate.  Trait [`Cast`] is implemented for

    - all primitive numeric types,
    - array types whose elements' types implement trait [`Cast`],
    - `struct` types and `union` types whose all fields' types implement
      trait [`Cast`] and whose type definitions are annotated with both
      attribute `#[`[`derive(Cast)`]`]` and attribute
      `#[`[`repr(C)`]`]`, and
    - `struct` types with no field and whose type definitions are
      annotated with attribute `#[`[`derive(Cast)`]`]`.

2. Trait [`Flip`] : The endiannesses of the values of types
   implementing trait [`Flip`] can be flipped by the methods of this
   crate.  Trait [`Flip`] is implemented for

    - all primitive numeric types,
    - array types whose elements' types implement trait [`Flip`],
    - `struct` types whose all fields' types implement trait [`Flip`] or
      with no field, and whose type definitions are annotated with
      attribute `#[`[`derive(Flip)`]`]`, and
    - `struct` types and `union` types whose all fields' types
      implement trait [`Flip`] and whose type definitions are annotated
      with attribute `#[`[`derive(NopFlip)`]`]`[^NopFlip].

Fore more information, see the document of each trait or derive macro.

# Supplementary Bounds : `NopFlip`

The following trait is a subtrait of trait [`Flip`].

3. Trait [`NopFlip`] : Types that implement trait [`NopFlip`] also
   implement trait [`Flip`] whose methods do nothing.  Trait
   [`NopFlip`] is implemented for

    - `struct` types and `union` types whose all fields' types
      implement trait [`Flip`] or with no field and whose type
      definitions are annotated with attribute
      `#[`[`derive(NopFlip)`]`]`[^NopFlip].

Fore more information, see the document of the trait or the derive macro.

# Derive Macros : `Cast`, `Flip` and `NopFlip`

By applying the following attributes to a `struct` type or a `union`
type, the type implements the corresponding trait or traits as listed
below.

- By applying `#[`[`derive(Cast)`]`]` and `#[`[`repr(C)`]`]` to a
  type, the type implements trait [`Cast`].

- By applying `#[`[`derive(Flip)`]`]` to a type, the type implements
  trait [`Flip`].

- By applying `#[`[`derive(NopFlip)`]`]` to a type, the type
  implements both trait [`Flip`] whose methods do nothing and trait
  [`NopFlip`].

[^encast]: In this crate, to *encast* means to cast a byte
representation of a type as a value of the type.

[^decast]: In this crate, to *decast* means to cast a value of a type
as a byte representation of the type.

[^NopFlip]: The types annotated with attribute `#[`[`derive(NopFlip)`]`]`
implement both trait [`Flip`] with NOP (No OPeration) methods and
marker trait [`NopFlip`].

[`derive(Cast)`]: ../../derive.Cast.html
[`derive(Flip)`]: ../../derive.Flip.html
[`derive(NopFlip)`]: ../../derive.NopFlip.html

[`repr(C)`]: https://doc.rust-lang.org/reference/type-layout.html#the-c-representation