robin/bitbuffer
1
0
Fork 0
mirror of https://codeberg.org/icewind/bitbuffer.git synced 2026-06-04 00:54:07 +02:00
Code Issues Releases Wiki Activity

flake updates

Browse source
This commit is contained in:
Robin Appelman 2025-05-23 22:22:43 +02:00
commit acb6265b83
3 changed files with 59 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -4,27 +4,40 @@
# bitbuffer
Tools for reading and writing data types of arbitrary bit length and might not be byte-aligned in the source data
Tools for reading and writing data types of arbitrary bit length and might not
be byte-aligned in the source data
The main way of reading the binary data is to first create a `BitReadBuffer` ,wrap it into a `BitReadStream` and then read from the stream.
The main way of reading the binary data is to first create a `BitReadBuffer`
,wrap it into a `BitReadStream` and then read from the stream.
Once you have a BitStream, there are 2 different approaches of reading data
- read primitives, Strings and byte arrays, using `read_bool`, `read_int`, `read_float`, `read_bytes` and `read_string`
- read any type implementing the `BitRead` or `BitReadSized` traits using `read` and `read_sized`
- `BitRead` is for types that can be read without requiring any size info (e.g. null-terminal strings, floats, whole integers, etc)
- `BitReadSized` is for types that require external sizing information to be read (fixed length strings, arbitrary length integers
- read primitives, Strings and byte arrays, using `read_bool`, `read_int`,
`read_float`, `read_bytes` and `read_string`
- read any type implementing the `BitRead` or `BitReadSized` traits using `read`
and `read_sized`
- `BitRead` is for types that can be read without requiring any size info
(e.g. null-terminal strings, floats, whole integers, etc)
- `BitReadSized` is for types that require external sizing information to be
read (fixed length strings, arbitrary length integers
The `BitRead` and `BitReadSized` traits can be used with `#[derive]` if all fields implement `BitRead` or `BitReadSized`.
The `BitRead` and `BitReadSized` traits can be used with `#[derive]` if all
fields implement `BitRead` or `BitReadSized`.
For writing the data you wrap the output `Vec` into a `BitWriteStream` which can then be used in a manner similar to the `BitReadStream`
For writing the data you wrap the output `Vec` into a `BitWriteStream` which can
then be used in a manner similar to the `BitReadStream`
- write primitives, Strings and byte arrays, using `write_bool`, `write_int`, `write_float`, `write_bytes` and `write_string`
- write any type implementing the `BitWrite` or `BitWriteSized` traits using `write` and `write_sized`
- `BitWrite` is for types that can be written without requiring any size info (e.g. null-terminal strings, floats, whole integers, etc)
- `BitWriteSized` is for types that require external sizing information to be written (fixed length strings, arbitrary length integers
- write primitives, Strings and byte arrays, using `write_bool`, `write_int`,
`write_float`, `write_bytes` and `write_string`
- write any type implementing the `BitWrite` or `BitWriteSized` traits using
`write` and `write_sized`
- `BitWrite` is for types that can be written without requiring any size info
(e.g. null-terminal strings, floats, whole integers, etc)
- `BitWriteSized` is for types that require external sizing information to be
written (fixed length strings, arbitrary length integers
Just like the read counterparts, `BitWrite` and `BitWriteSized` traits can be used with `#[derive]` if all fields implement `BitWrite` or `BitWriteSized`.
Just like the read counterparts, `BitWrite` and `BitWriteSized` traits can be
used with `#[derive]` if all fields implement `BitWrite` or `BitWriteSized`.
# Examples
@ -62,14 +75,15 @@ write_stream.write(&ComplexType {
Licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
https://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
https://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.