13 releases (5 stable)
1.2.2 | Oct 28, 2022 |
---|---|
1.2.1 | Feb 25, 2022 |
1.2.0 | Oct 19, 2021 |
1.0.0 | Oct 13, 2020 |
0.1.0 | Aug 14, 2017 |
#96 in Rust patterns
726,152 downloads per month
Used in 2,225 crates
(48 directly)
34KB
729 lines
byte-slice-cast
Safely cast between byte slices and slices of another built-in fundamental number type.
LICENSE
byte-slice-cast is licensed under the MIT license (LICENSE or http://opensource.org/licenses/MIT).
Contribution
Any kinds of contributions are welcome as a pull request.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in byte-slice-cast by you shall be licensed under the MIT license as above, without any additional terms or conditions.
lib.rs
:
Safely cast bytes slices from/to slices of built-in fundamental numeric types.
The provided traits here allow safe casting between byte slices and slices of fundamental numeric types, like integers and floating point numbers. During casting, checks are performed to ensure that the output slice is safe to use: the input slice must be properly aligned for the output type and contain an integer number of values.
Instead of working only on slices, the traits work on AsRef<[T]>
in the immutable case and on
AsMut<[T]>
for the mutable case. As such, it is possible to directly work on e.g. Vec<T>
and Box<[T]>
too.
The content of the output slice will be bitwise equivalent to the input slice, as such extra care has to be taken with regard to endianness.
Example with slices
use byte_slice_cast::*;
let slice = [0x0102u16, 0x0304u16, 0x0506u16];
let converted_slice = slice.as_byte_slice();
if cfg!(target_endian = "big") {
assert_eq!(converted_slice, &[1, 2, 3, 4, 5, 6]);
} else {
assert_eq!(converted_slice, &[2, 1, 4, 3, 6, 5]);
}
let converted_back_slice = converted_slice.as_slice_of::<u16>().unwrap();
assert_eq!(converted_back_slice, &slice);
Example with mutable slices
use byte_slice_cast::*;
let mut slice = [0u32; 1];
let mut converted_slice = slice.as_mut_byte_slice();
converted_slice.copy_from_slice(&[0x12, 0x34, 0x56, 0x78]);
let mut converted_slice = converted_slice.as_mut_slice_of::<u16>().unwrap();
converted_slice[0] = 0xffff;
if cfg!(target_endian = "big") {
assert_eq!(&slice, &[0xffff5678]);
} else {
assert_eq!(&slice, &[0x7856ffff]);
}