Struct CopyDataBuilder 

pub struct CopyDataBuilder { /* private fields */ }

A builder for HyperBinary COPY data.

Provides a convenient interface for constructing HyperBinary COPY format data. Automatically writes the header before the first data value.

Example

use hyperdb_api_core::protocol::copy::CopyDataBuilder;

let mut builder = CopyDataBuilder::new(1024);
builder.write_i32(42, false);
builder.write_str("hello", false);
let data = builder.take();

Implementations

impl CopyDataBuilder

pub fn new(capacity: usize) -> Self

Creates a new builder with the specified initial capacity.

Arguments

• capacity - Initial buffer capacity in bytes

pub fn with_default_capacity() -> Self

Creates a new builder with default capacity (1 MB).

pub fn ensure_header(&mut self)

Ensures the HyperBinary COPY header is written.

Called automatically before writing any data. Writes the header only once, even if called multiple times.

pub fn write_null(&mut self)

Writes a NULL value.

pub fn write_bool(&mut self, value: bool, nullable: bool)

Writes a boolean value.

pub fn write_i16(&mut self, value: i16, nullable: bool)

Writes an i16 value.

pub fn write_i32(&mut self, value: i32, nullable: bool)

Writes an i32 value.

pub fn write_i64(&mut self, value: i64, nullable: bool)

Writes an i64 value.

pub fn write_data128(&mut self, value: &[u8; 16], nullable: bool)

Writes a 128-bit value.

pub fn write_varbinary(&mut self, value: &[u8], nullable: bool)

Writes a variable-length binary value (text, bytea, etc.).

pub fn write_str(&mut self, value: &str, nullable: bool)

Writes a string value.

pub fn len(&self) -> usize

Returns the current buffer size in bytes.

Includes the header if it has been written.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty (no data written yet).

Note: This returns true even if the header has been written, since the header is written automatically before data.

pub fn take(&mut self) -> BytesMut

Returns the buffer contents and resets the builder.

The builder can be reused after calling this method. The header flag is reset, so the header will be written again on the next write operation.

pub fn as_bytes(&self) -> &[u8]

Returns a reference to the buffer contents.

Useful for inspecting the data without consuming it.

pub fn clear(&mut self)

Clears the buffer and resets the header flag.

The builder can be reused after clearing. The capacity is preserved.

Trait Implementations

impl Debug for CopyDataBuilder

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

Formats the value using the given formatter.

impl Default for CopyDataBuilder

fn default() -> Self

Returns the “default value” for a type.