class BinaryDecoder

Light-weight class for decoding packed structs in a safe manner.

Each operation returns either a specified struct or an error

indicating that the read would go out of bounds of the original input

buffer. Successful reads consume bytes from the buffer, while failed

reads don't modify internal state.

The code avoids performing unaligned reads.

A typical use will be as follows:

// Give the decoder a reference to binary data.

BinaryDecoder decoder(cpp20::span

<const

uint8_t>(...));

// Read some structures.

StatusOr

<int32

_t> a = decoder.Read

<int32

_t>();

StatusOr

<MyStruct

> b = decoder.Read

<MyStruct

>();

StatusOr

<OtherStruct

> c = decoder.Read

<OtherStruct

>();

// Read off a range of 16 bytes.

StatusOr

<cpp20

::span

<const

uint8_t>> bytes = decoder.Read(16);

// Read off a struct that encodes its length as a field.

//

// The result will consist of a "MyStruct" and additional payload data

// as a byte range.

StatusOr

<std

::tuple

<MyStruct

, cpp20::span

<const

uint8_t>>> data

= decoder.VariableLengthRead

<MyStruct

>(

&MyStruct

::length);