ribs_binary

Classes

Class	Description
Alphabet	Defines the bidirectional mapping between integer indices and characters for a positional numeral system.
Alphabets	Provides a collection of pre-defined Alphabet instances for common base encodings.
At	Represents a view or segment of bytes.
Base32Alphabet	An Alphabet for base-32 encoding.
Base32Crockford	Crockford's Base32 alphabet implementation.
Base58Alphabet	An Alphabet for base-58 encoding.
Base64Alphabet	An Alphabet for base-64 encoding.
Bases	Constants used by Alphabet implementations to signal special handling of characters during base decoding.
BinaryAlphabet	An Alphabet for base-2 (binary) encoding.
BitVector	An immutable, indexable sequence of bits with rich operations for binary data manipulation.
Bytes	A leaf BitVector node backed by a contiguous ByteVector.
ByteVector	An immutable, indexable sequence of bytes with rich operations for binary data manipulation.
Codec<A>	Defines a typeclass capable of both encoding to and decoding from binary data.
Crc	Factory methods for creating CRC (Cyclic Redundancy Check) computation functions.
CrcBuilder<R>	An immutable builder for incrementally computing a CRC checksum over chunks of BitVector data.
CrcParams	Parameters that fully define a CRC (Cyclic Redundancy Check) algorithm.
Decoder<A>	Typeclass for binary decoding: consumes a prefix of a BitVector and produces a typed DecodeResult or an Err.
DecodeResult<A>	The result of a successful Decoder.decode call, carrying the decoded value and the unconsumed remainder of the input BitVector.
Encoder<A>	Class for binary encoding: converts a value of type A into a BitVector or an Err.
Err	Base type for errors that occur during binary decoding or encoding.
General	A general-purpose codec error with a freeform message.
HexAlphabet	An Alphabet for base-16 (hexadecimal) encoding.
HexDumpFormat	Configuration for formatting a BitVector as a hex dump.
InsufficientBits	Error indicating that decoding requires more bits than are available.
LenientHex	A HexAlphabet with lenient decoding that silently ignores whitespace, underscores, and line comments.
PaddedAlphabet	An Alphabet that includes a padding character used to align encoded output to a required block size.
StreamDecoder<To>	A StreamTransformer that applies a Decoder to a stream of BitVector chunks, emitting decoded values as they arrive.
StreamEncoder<A>	A StreamTransformer that encodes each element using an Encoder, emitting the resulting BitVector for each successful encoding.

Extensions

Extension	on	Description
CodecOps<A>	Codec<A>	Extension providing additional combinators on Codec.
CodecTuple10Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9>	Record	Provides a product operation on a 10-tuple of Codecs.
CodecTuple11Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>	Record	Provides a product operation on a 11-tuple of Codecs.
CodecTuple12Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>	Record	Provides a product operation on a 12-tuple of Codecs.
CodecTuple13Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>	Record	Provides a product operation on a 13-tuple of Codecs.
CodecTuple14Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>	Record	Provides a product operation on a 14-tuple of Codecs.
CodecTuple15Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14>	Record	Provides a product operation on a 15-tuple of Codecs.
CodecTuple16Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15>	Record	Provides a product operation on a 16-tuple of Codecs.
CodecTuple17Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16>	Record	Provides a product operation on a 17-tuple of Codecs.
CodecTuple18Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17>	Record	Provides a product operation on a 18-tuple of Codecs.
CodecTuple19Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18>	Record	Provides a product operation on a 19-tuple of Codecs.
CodecTuple20Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19>	Record	Provides a product operation on a 20-tuple of Codecs.
CodecTuple21Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20>	Record	Provides a product operation on a 21-tuple of Codecs.
CodecTuple22Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21>	Record	Provides a product operation on a 22-tuple of Codecs.
CodecTuple2Ops<T0, T1>	Record	Provides a product operation on a 2-tuple of Codecs.
CodecTuple3Ops<T0, T1, T2>	Record	Provides a product operation on a 3-tuple of Codecs.
CodecTuple4Ops<T0, T1, T2, T3>	Record	Provides a product operation on a 4-tuple of Codecs.
CodecTuple5Ops<T0, T1, T2, T3, T4>	Record	Provides a product operation on a 5-tuple of Codecs.
CodecTuple6Ops<T0, T1, T2, T3, T4, T5>	Record	Provides a product operation on a 6-tuple of Codecs.
CodecTuple7Ops<T0, T1, T2, T3, T4, T5, T6>	Record	Provides a product operation on a 7-tuple of Codecs.
CodecTuple8Ops<T0, T1, T2, T3, T4, T5, T6, T7>	Record	Provides a product operation on a 8-tuple of Codecs.
CodecTuple9Ops<T0, T1, T2, T3, T4, T5, T6, T7, T8>	Record	Provides a product operation on a 9-tuple of Codecs.

Typedefs

Typedef	Description
DecodeF<A>	Function type alias that a Decoder must fulfill.
EncodeF<A>	Function type alias for encoding a value of type A to a BitVector.