Struct KdbCodec 

pub struct KdbCodec { /* private fields */ }

Kdb+ Protocol Codec

This codec handles encoding and decoding of kdb+ IPC messages. It manages the message framing, compression, and serialization/deserialization of K objects.

Implementations

impl KdbCodec

pub fn new(is_local: bool) -> Self

Create a new KdbCodec with default settings (Auto compression, Strict validation)

Parameters

• is_local: Whether the connection is within the same host (affects compression in Auto mode)

pub fn with_options( is_local: bool, compression_mode: CompressionMode, validation_mode: ValidationMode, ) -> Self

Create a new KdbCodec with custom compression and validation modes

Parameters

• is_local: Whether the connection is within the same host (affects compression in Auto mode)
• compression_mode: How to handle message compression
• validation_mode: How strictly to validate incoming messages

Example

use kdb_codec::{KdbCodec, CompressionMode, ValidationMode};

// Always compress, lenient validation
let codec = KdbCodec::with_options(false, CompressionMode::Always, ValidationMode::Lenient);

pub fn set_compression_mode(&mut self, mode: CompressionMode)

Set the compression mode

pub fn compression_mode(&self) -> CompressionMode

Get the current compression mode

pub fn set_validation_mode(&mut self, mode: ValidationMode)

Set the validation mode

pub fn validation_mode(&self) -> ValidationMode

Get the current validation mode

pub fn builder() -> KdbCodecBuilder

Create a builder for KdbCodec with fluent API

Example

use kdb_codec::{KdbCodec, CompressionMode, ValidationMode};

// Using builder pattern
let codec = KdbCodec::builder()
    .is_local(false)
    .compression_mode(CompressionMode::Always)
    .validation_mode(ValidationMode::Lenient)
    .build();

Trait Implementations

impl Clone for KdbCodec

fn clone(&self) -> KdbCodec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KdbCodec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decoder for KdbCodec

type Item = KdbMessage

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Self::Item>>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Encoder<KdbMessage> for KdbCodec

type Error = Error

The type of encoding errors.

fn encode(&mut self, item: KdbMessage, dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.