Skip to main content

Crate qubit_codec

Crate qubit_codec 

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

Macros§

nz
Const-friendly wrapper around nz for use in expression position.

Structs§

BigEndian
Type-level marker for big-endian byte order.
CodecTranscodeConverter
Converts source units to target units through a decoded value by using codecs.
CodecTranscodeDecoder
Decodes encoded units into caller-provided value buffers by using a Codec.
CodecTranscodeEncoder
Encodes values into caller-provided output units by using a Codec.
CodecValueDecoder
Decodes one encoded unit slice into one owned value by using a Codec.
CodecValueEncoder
Encodes one borrowed value into owned units by using a Codec.
DecodeContext
Context for one codec decode attempt inside a buffered decoder engine.
EncodeContext
Context for one encode attempt inside a buffered encoder engine.
EncodePlan
Describes how much output capacity one encoded value needs before writing.
LittleEndian
Type-level marker for little-endian byte order.
TranscodeConvertEngine
Reusable buffered conversion engine.
TranscodeDecodeEngine
Reusable buffered decoding engine for codec-backed decoders.
TranscodeDecodeInput
Decodes an Input unit stream into an Input value stream.
TranscodeEncodeEngine
Reusable buffered encoding engine for codec-backed encoders.
TranscodeEncodeOutput
Encodes an Output value stream into an Output unit stream.
TranscodeProgress
Counts how much work a crate::Transcoder completed before returning.

Enums§

ByteOrder
Runtime byte order selector.
CapacityError
Error reported by output-capacity planning APIs.
CodecConvertError
Error reported by codec-backed buffered converters.
CodecDecodeError
Error reported by codec-backed value and buffered decoder adapters.
CodecEncodeError
Error reported by codec-backed buffered encoder adapters.
DecodeAction
Action selected after a codec decode attempt fails during transcode.
TranscodeError
Error reported by a transcode operation.
TranscodeStatus
Reports why a crate::Transcoder stopped converting input.

Traits§

ByteOrderSpec
Describes a type-level byte order.
Codec
Encodes and decodes one value or codec quantum against a unit buffer.
CodecDecodeErrorSignal
Optional stream-recovery signals exposed by codec decode errors.
CodecValueExt
Extension trait for checked one-value codec operations.
TranscodeConvertHooks
Policy hooks for crate::TranscodeConvertEngine.
TranscodeConverter
Converts encoded units of one representation into encoded units of another.
TranscodeDecodeHooks
Policy hooks for crate::TranscodeDecodeEngine.
TranscodeDecoder
Decodes encoded units into logical values over caller-provided buffers.
TranscodeEncodeHooks
Policy hooks for crate::TranscodeEncodeEngine.
TranscodeEncoder
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.
ValueDecoder
Decodes a borrowed input value into an owned representation.
ValueEncoder
Encodes a borrowed input value into an owned representation.

Functions§

nz
Returns a NonZeroUsize from a known non-zero compile-time constant.