asbytes 0.3.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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

/// Define a private namespace for all its items.
mod private
{

  pub use bytemuck :: { Pod };

  /// Trait for borrowing data as byte slices.
  /// This trait abstracts the conversion of types that implement Pod (or collections thereof)
  /// into their raw byte representation as a slice (`&[ u8]`).
  pub trait AsBytes
  {
  /// Returns the underlying byte slice of the data.
  fn as_bytes( &self ) -> &[ u8 ];

  /// Returns an owned vector containing a copy of the bytes of the data.
  /// The default implementation clones the bytes from `as_bytes()`.
  #[ inline ]
  fn to_bytes_vec( &self ) -> Vec< u8 >
  {
  self.as_bytes().to_vec()
 }

  /// Returns the size in bytes of the data.
  #[ inline ]
  fn byte_size( &self ) -> usize
  {
  self.as_bytes().len()
 }

  /// Returns the count of elements contained in the data.
  /// For single-element tuples `(T,)`, this is 1.
  /// For collections (`Vec< T >`, `&[ T ]`, `[ T; N ]`), this is the number of `T` items.
  fn len( &self ) -> usize;
  
  /// Returns true if the data contains no elements.
  #[ inline ]
  fn is_empty( &self ) -> bool
  {
  self.len() == 0
 }
 }

  /// Implementation for single POD types wrapped in a tuple `( T, )`.
  impl< T: Pod > AsBytes for ( T, ) 
{
  #[ inline ]
  fn as_bytes( &self ) -> &[ u8 ]
  {
  bytemuck ::bytes_of( &self.0 )
 }

  #[ inline ]
  fn byte_size( &self ) -> usize
  {
  core ::mem ::size_of :: < T >()
 }

  #[ inline ]
  fn len( &self ) -> usize
  {
  1
 }
 }

  /// Implementation for Vec< T > where T is POD.
  impl< T: Pod > AsBytes for Vec< T > 
{
  #[ inline ]
  fn as_bytes( &self ) -> &[ u8] 
  {
   bytemuck ::cast_slice(self)
 }

  #[ inline ]
  fn byte_size( &self ) -> usize 
  {
   self.len() * core ::mem ::size_of :: < T >()
 }

  #[ inline ]
  fn len( &self ) -> usize 
  {
   self.len()
 }
 }

  /// Implementation for [T] where T is POD.
  impl< T: Pod > AsBytes for [T] 
{
  #[ inline ]
  fn as_bytes( &self ) -> &[ u8] 
  {
   bytemuck ::cast_slice(self)
 }

  #[ inline ]
  fn byte_size( &self ) -> usize 
  {
   core ::mem ::size_of_val(self)
 }

  #[ inline ]
  fn len( &self ) -> usize 
  {
   self.len()
 }
 }

  /// Implementation for [T; N] where T is POD.
  impl< T: Pod, const N: usize > AsBytes for [T; N] 
{
  #[ inline ]
  fn as_bytes( &self ) -> &[ u8] 
  {
   bytemuck ::cast_slice(self)
 }

  #[ inline ]
  fn byte_size( &self ) -> usize 
  {
   N * core ::mem ::size_of :: < T >()
 }

  #[ inline ]
  fn len( &self ) -> usize 
  {
   N
 }
 }
}

#[ doc( inline ) ]
#[ allow( unused_imports ) ]
pub use own :: *;

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

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

/// Orphan namespace of the module.
#[ allow( unused_imports ) ]
pub mod orphan 
{
  use super :: *;
  #[ doc( inline ) ]
  pub use exposed :: *;
}

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

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

/// Prelude to use essentials: `use my_module ::prelude :: *`.
#[ allow( unused_imports ) ]
pub mod prelude 
{
  use super :: *;

  pub use private ::AsBytes;
}