Skip to main content

CopyEncoder

Struct CopyEncoder 

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

Encoder for COPY operations.

This encoder produces CopyData messages for PGCOPY binary, text, and CSV formats.

Implementations§

Source§

impl CopyEncoder

Source

pub fn new_binary(schema: Arc<Vec<FieldInfo>>) -> Self

Create a new binary format COPY encoder.

Source

pub fn new_text(schema: Arc<Vec<FieldInfo>>, options: CopyTextOptions) -> Self

Create a new text format COPY encoder.

Source

pub fn new_csv(schema: Arc<Vec<FieldInfo>>, options: CopyCsvOptions) -> Self

Create a new CSV format COPY encoder.

Source

pub fn encode_field<T>(&mut self, value: &T) -> PgWireResult<()>
where T: ToSql + ToSqlText + Sized,

Encode a field value.

This method uses the type and format information from the schema.

Source

pub fn take_copy(&mut self) -> CopyData

Take the current row as a CopyData message.

For binary format: first call includes PGCOPY header. For text/CSV format: each call returns one row with a trailing newline.

Source

pub fn finish_copy_binary() -> CopyData

Finish the COPY operation of binary format.

For binary format: returns trailer (-1). Note that this trailer is automatically appended to stream if you use CopyResponse API.

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, 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