Crate csharp_binary_encoding

Source
Expand description

§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

// &[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()?);

§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.

Structs§

BinaryReader
Analogous to the System.IO.BinaryReader C# Class.
BinaryWriter
Analagous to the System.IO.BinaryWriter C# Class.

Enums§

DataDecodeError
Indicates that an error has occured because the bytes being decoded were invalid in some way.