csharp_binary_encoding 0.2.0

Decode binary data written by C#'s BinaryWriter class.
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

# csharp_binary_encoding
A crate for handling binary data in the format used by the C# [`System.IO.BinaryReader`] and [`System.IO.BinaryWriter`] Classes.
## Features
- `f16` Enables function for decoding f16 values. Must be compiled with nightly, since f16 is currently an unstable feature in rust.
## Example
```
# use std::io::Cursor;
# use std::io::Error;
# use csharp_binary_encoding::{BinaryReader};
// &[u8] implements read
let bytes: [u8; 11] = [ 0x8F, 0x72, 0x04, 0x6D, 0x65, 0x6F, 0x77, 0xD7, 0xA3, 0xE8, 0x40 ];

// Construct a reader
let mut reader = BinaryReader::new(bytes.as_slice());

// Read values
assert_eq!(Ok(14607), reader.read_7_bit_encoded_int()?);
assert_eq!(Ok("meow".to_string()), reader.read_string()?);
assert_eq!(Ok(7.27_f32), reader.read_f32()?);
# Ok::<(), Error>(())
```

## Limitations
- Currently, only the utf-8 encoding is supported.
- Developed for and tested with .NET version 9.0. Compatibility with other versions is likely
  present but should not be counted on.

[`System.IO.BinaryWriter`]: <https://learn.microsoft.com/en-us/dotnet/api/system.io.binarywriter>
[`System.IO.BinaryReader`]: <https://learn.microsoft.com/en-us/dotnet/api/system.io.binaryreader>