Skip to main content

CopyIn

Struct CopyIn 

Source
#[non_exhaustive]
pub struct CopyIn<'a> { /* private fields */ }
Expand description

A writer for a COPY IN operation.

Created via Connection::copy_in. Data is sent to the server in chunks. The operation must be completed with finish or cancelled with cancel.

Implementations§

Source§

impl<'a> CopyIn<'a>

Source

pub fn format(&self) -> u8

The overall format code for this COPY operation.

0 = text, 1 = binary.

Source

pub fn column_formats(&self) -> &[u16]

Per-column format codes.

Source

pub async fn write(&mut self, data: &[u8]) -> Result<()>

Send a raw chunk of COPY data.

Source

pub async fn write_row(&mut self, columns: &[&str]) -> Result<()>

Send a single text-format row.

Columns are joined with \t and terminated with \n.

Source

pub async fn write_csv_row( &mut self, columns: &[&str], delimiter: char, quote: char, ) -> Result<()>

Send a single CSV-format row.

This uses PostgreSQL CSV format rules: fields containing the delimiter, quote character, or newline are wrapped in quotes; quotes inside quoted fields are doubled.

Note: This method cannot represent NULL values. Use write_csv_row_with_null if you need NULL support.

Source

pub async fn write_csv_row_with_null( &mut self, columns: &[Option<&str>], delimiter: char, quote: char, null_string: &str, ) -> Result<()>

Send a single CSV-format row with NULL support.

Like write_csv_row, but each column is an Option<&str>. None values are written as the null_string parameter (typically "" for the default PostgreSQL CSV NULL representation, which is an empty string).

§Example
let mut copy = conn.copy_in("COPY users (id, name) FROM STDIN WITH (FORMAT csv)").await?;
copy.write_csv_row_with_null(
    &[Some("1"), None, Some("active")],
    ',', '"', "",
).await?;
Source

pub async fn finish(self) -> Result<u64>

Finish the COPY operation successfully.

Sends CopyDone and waits for CommandComplete + ReadyForQuery. Returns the number of rows copied.

Source

pub async fn cancel(self, reason: &str) -> Result<()>

Cancel the COPY operation.

Sends CopyFail with the given reason and waits for the server to return to ready state.

Trait Implementations§

Source§

impl<'a> Drop for CopyIn<'a>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for CopyIn<'a>

§

impl<'a> !RefUnwindSafe for CopyIn<'a>

§

impl<'a> Send for CopyIn<'a>

§

impl<'a> Sync for CopyIn<'a>

§

impl<'a> Unpin for CopyIn<'a>

§

impl<'a> UnsafeUnpin for CopyIn<'a>

§

impl<'a> !UnwindSafe for CopyIn<'a>

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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