27 releases (8 stable)
1.7.0 | Jul 5, 2023 |
---|---|
1.6.0 | Nov 17, 2022 |
1.5.0 | Jun 13, 2022 |
1.3.0 | Mar 25, 2022 |
0.6.1 | Mar 27, 2017 |
#90 in Encoding
41,361 downloads per month
Used in 65 crates
(33 directly)
120KB
2K
SLoC
bitstream-io
A Rust library for reading or writing binary values to or from streams which may not be aligned at a whole byte.
This library is intended to be flexible enough to wrap
around any stream which implements the Read
or Write
traits.
It also supports a wide array of integer data types as
containers for those binary values.
lib.rs
:
Traits and helpers for bitstream handling functionality
Bitstream readers are for reading signed and unsigned integer values from a stream whose sizes may not be whole bytes. Bitstream writers are for writing signed and unsigned integer values to a stream, also potentially un-aligned at a whole byte.
Both big-endian and little-endian streams are supported.
The only requirement for wrapped reader streams is that they must
implement the Read
trait, and the only requirement
for writer streams is that they must implement the Write
trait.
In addition, reader streams do not consume any more bytes from the underlying reader than necessary, buffering only a single partial byte as needed. Writer streams also write out all whole bytes as they are accumulated.
Readers and writers are also designed to work with integer types of any possible size. Many of Rust's built-in integer types are supported by default.
Migrating From Pre 1.0.0
There are now BitRead
and BitWrite
traits for bitstream
reading and writing (analogous to the standard library's
Read
and Write
traits) which you will also need to import.
The upside to this approach is that library consumers
can now make functions and methods generic over any sort
of bit reader or bit writer, regardless of the underlying
stream byte source or endianness.