docs
API
Generated with
docs/scalus/scalus.serialization/scalus.serialization.flat/FlatInstances/given_Flat_Data

given_Flat_Data

scalus.serialization.flat.FlatInstances.given_Flat_Data
object given_Flat_Data extends Flat[Data]

Attributes

Graph
Supertypes
trait Flat[Data]
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def bitSize(a: Data): Int

Exact size of the encoding of a in bits. Callers use it to size the EncoderState buffer, so it must never under-estimate.

Exact size of the encoding of a in bits. Callers use it to size the EncoderState buffer, so it must never under-estimate.

Attributes

def decode(decode: DecoderState): Data

Reads an A, advancing decode past the bits it consumed.

Reads an A, advancing decode past the bits it consumed.

Decoding stops as soon as it has an A; it does not check for trailing input, so a caller that requires the whole buffer to be consumed must check that itself.

Attributes

Throws
FlatDecodingError

if the input is truncated or is not a valid encoding of A. Bytes from an untrusted source are expected to fail this way; any other exception is a defect.

def encode(a: Data, enc: EncoderState): Unit

Writes a into encode.

Writes a into encode.

The buffer does not grow, so it must already have room for bitSize bits. Failing that is a defect in this instance rather than a problem with a: an under-estimating bitSize overruns the buffer with an ArrayIndexOutOfBoundsException, and a negative size is rejected by EncoderState with an IllegalArgumentException. Use [[FlatCodec.encodeA*]] to get the sizing right.

Attributes

Generated with