Skip to main content

BinaryCopyEncoder

Struct BinaryCopyEncoder 

Source
pub struct BinaryCopyEncoder { /* private fields */ }
Expand description

Encoder for binary COPY IN format.

Builds a buffer containing the binary header, tuple data, and trailer.

§Example

use sentinel_driver::copy::binary::BinaryCopyEncoder;

let mut encoder = BinaryCopyEncoder::new();

// Write a row with two columns: int4(42) and text("hello")
encoder.begin_row(2);
encoder.write_field(&42i32.to_be_bytes());
encoder.write_field(b"hello");

// Write another row with a NULL second column
encoder.begin_row(2);
encoder.write_field(&7i32.to_be_bytes());
encoder.write_null();

let data = encoder.finish();
// data can be sent via CopyIn::write_raw()

Implementations§

Source§

impl BinaryCopyEncoder

Source

pub fn new() -> Self

Source

pub fn begin_row(&mut self, field_count: i16)

Begin a new row with the given number of fields.

Source

pub fn write_field(&mut self, data: &[u8])

Write a non-NULL field value (already in binary PG format).

Source

pub fn write_null(&mut self)

Write a NULL field.

Source

pub fn finish(self) -> Vec<u8>

Finish encoding and return the complete binary COPY data.

Appends the trailer (field_count = -1).

Source

pub fn len(&self) -> usize

Get the current buffer size.

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

impl Default for BinaryCopyEncoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more