Expand description
§qubit-codec
Core codec traits and buffer conversion primitives for Rust applications.
This crate contains only domain-neutral building blocks such as value
codecs, owned value encoder/decoder helpers, byte-order markers, and
progress-oriented buffer transcoders. The only I/O-facing types are the
low-level qubit_io::Input/qubit_io::Output bridges used by downstream
stream crates. Concrete binary, text, misc, and std::io adapters live in
sibling crates.
Structs§
- BigEndian
- Type-level marker for big-endian byte order.
- Codec
Transcode Converter - Converts source units to target units through a decoded value by using codecs.
- Codec
Transcode Decoder - Decodes encoded units into caller-provided value buffers by using a
Codec. - Codec
Transcode Encoder - Encodes values into caller-provided output units by using a
Codec. - Codec
Value Decoder - Decodes one encoded unit slice into one owned value by using a
Codec. - Codec
Value Encoder - Encodes one borrowed value into owned units by using a
Codec. - Decode
Context - Context for one codec decode attempt inside a buffered decoder engine.
- Encode
Context - Context for one encode attempt inside a buffered encoder engine.
- Little
Endian - Type-level marker for little-endian byte order.
- Transcode
Convert Engine - Reusable buffered conversion engine for codec-backed converters.
- Transcode
Decode Engine - Reusable buffered decoding engine for codec-backed decoders.
- Transcode
Decode Input - Decodes an
Inputunit stream into anInputvalue stream. - Transcode
Encode Engine - Reusable buffered encoding engine for codec-backed encoders.
- Transcode
Encode Output - Encodes an
Outputvalue stream into anOutputunit stream. - Transcode
Progress - Counts how much work a
crate::Transcodercompleted before returning.
Enums§
- Byte
Order - Runtime byte order selector.
- Capacity
Error - Error reported by output-capacity planning APIs.
- Codec
Convert Error - Domain error reported by codec-backed converter adapters.
- Codec
Decode Error - Error reported by codec-backed value and buffered decoder adapters.
- Codec
Encode Error - Error reported by codec-backed buffered encoder adapters.
- Decode
Failure - Failure reported by
crate::Codec::decode. - Decode
Invalid Action - Action selected after a codec reports invalid encoded input.
- Encode
Outcome - Outcome returned by encode-side per-value hooks.
- Transcode
Contract Error - Error reported when a transcoder returns inconsistent progress.
- Transcode
Convert Engine Error - Error reported by
crate::TranscodeConvertEngine. - Transcode
Decode Engine Error - Error reported by
crate::TranscodeDecodeEngine. - Transcode
Encode Engine Error - Error reported by
crate::TranscodeEncodeEngine. - Transcode
Error - Error reported by a transcode operation.
- Transcode
Status - Reports why a
crate::Transcoderstopped converting input.
Traits§
- Byte
Order Spec - Describes a type-level byte order.
- Codec
- Encodes and decodes one value or codec quantum against a unit buffer.
- Codec
Value Ext - Extension trait for checked one-value codec operations.
- Transcode
Converter - Converts encoded units of one representation into encoded units of another.
- Transcode
Decode Hooks - Policy hooks for
crate::TranscodeDecodeEngine. - Transcode
Decoder - Decodes encoded units into logical values over caller-provided buffers.
- Transcode
Encode Hooks - Policy hooks for
crate::TranscodeEncodeEngine. - Transcode
Encoder - Encodes logical values into encoded units over caller-provided buffers.
- Transcoder
- Converts one logical stream of input units into one logical stream of output units.
- Value
Decoder - Decodes a borrowed input value into an owned representation.
- Value
Encoder - Encodes a borrowed input value into an owned representation.
Type Aliases§
- Codec
Decode Exact Value With Flush Result - Result type returned by exact decode-and-flush one-value helpers.
- Codec
Decode Value With Flush Result - Result type returned by decode-and-flush one-value helpers.
- Codec
Encode Value Result - Result type returned by reset-prefixed one-value encode helpers.