asbytes 0.2.0

Traits for viewing data as byte slices or consuming data into byte vectors. Relies on bytemuck for POD safety.
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

#![ doc( html_logo_url = "https://raw.githubusercontent.com/Wandalen/wTools/master/asset/img/logo_v3_trans_square.png" ) ]
#![ doc( html_favicon_url = "https://raw.githubusercontent.com/Wandalen/wTools/alpha/asset/img/logo_v3_trans_square_icon_small_v2.ico" ) ]
#![ doc( html_root_url = "https://docs.rs/asbytes/latest/asbytes/" ) ]
#![ doc = include_str!( concat!( env!( "CARGO_MANIFEST_DIR" ), "/", "Readme.md" ) ) ]

/// Namespace with dependencies.
#[ cfg( feature = "enabled" ) ]
pub mod dependency
{
  // Only include bytemuck if either as_bytes or into_bytes is enabled
  #[ cfg( any( feature = "as_bytes", feature = "into_bytes" ) ) ]
  pub use ::bytemuck;
}

/// Define a private namespace for all its items.
#[ cfg( feature = "enabled" ) ]
mod private
{
}

#[ cfg( feature = "as_bytes" ) ]
mod as_bytes;
#[ cfg( feature = "into_bytes" ) ]
mod into_bytes;

#[ cfg( feature = "enabled" ) ]
#[ doc( inline ) ]
#[ allow( unused_imports ) ]
pub use own::*;

/// Own namespace of the module.
#[ cfg( feature = "enabled" ) ]
#[ allow( unused_imports ) ]
pub mod own
{
  use super::*;

  #[ doc( inline ) ]
  pub use orphan::*;

  #[ doc( inline ) ]
  #[ cfg( feature = "as_bytes" ) ]
  pub use as_bytes::orphan::*;
  #[ doc( inline ) ]
  #[ cfg( feature = "into_bytes" ) ]
  pub use into_bytes::orphan::*;

  // Re-export bytemuck items only if a feature needing it is enabled
  #[ cfg( any( feature = "as_bytes", feature = "into_bytes" ) ) ]
  #[ doc( inline ) ]
  pub use bytemuck::
  {
    checked,
    offset_of,
    bytes_of,
    bytes_of_mut,
    cast,
    cast_mut,
    cast_ref,
    cast_slice,
    cast_slice_mut,
    fill_zeroes,
    from_bytes,
    from_bytes_mut,
    pod_align_to,
    pod_align_to_mut,
    pod_read_unaligned,
    try_cast,
    try_cast_mut,
    try_cast_ref,
    try_cast_slice,
    try_cast_slice_mut,
    try_from_bytes,
    try_from_bytes_mut,
    try_pod_read_unaligned,
    write_zeroes,
    CheckedBitPattern,
    PodCastError,
    AnyBitPattern,
    Contiguous,
    NoUninit,
    Pod,
    PodInOption,
    TransparentWrapper,
    Zeroable,
    ZeroableInOption,
  };

  // Expose allocation submodule if into_bytes and extern_crate_alloc are enabled
  #[ cfg( all( feature = "into_bytes", feature = "extern_crate_alloc" ) ) ]
  pub use bytemuck::allocation;

}

#[ cfg( feature = "enabled" ) ]
#[ doc( inline ) ]
#[ allow( unused_imports ) ]
pub use own::*;

/// Orphan namespace of the module.
#[ cfg( feature = "enabled" ) ]
#[ allow( unused_imports ) ]
pub mod orphan
{
  use super::*;

  #[ doc( inline ) ]
  pub use exposed::*;

}

/// Exposed namespace of the module.
#[ cfg( feature = "enabled" ) ]
#[ allow( unused_imports ) ]
pub mod exposed
{
  use super::*;

  #[ doc( inline ) ]
  #[ cfg( feature = "as_bytes" ) ]
  pub use as_bytes::exposed::*;
  #[ doc( inline ) ]
  #[ cfg( feature = "into_bytes" ) ]
  pub use into_bytes::exposed::*;

  #[ doc( inline ) ]
  pub use prelude::*;

}

/// Prelude to use essentials: `use my_module::prelude::*`.
#[ cfg( feature = "enabled" ) ]
#[ allow( unused_imports ) ]
pub mod prelude
{
  use super::*;
  #[ doc( inline ) ]
  #[ cfg( feature = "as_bytes" ) ]
  pub use as_bytes::prelude::*;
  #[ doc( inline ) ]
  #[ cfg( feature = "into_bytes" ) ]
  pub use into_bytes::prelude::*;
}