Struct BinaryCopyInWriter

pub struct BinaryCopyInWriter { /* private fields */ }

A type which serializes rows into the PostgreSQL binary copy format.

The copy must be explicitly completed via the finish method. If it is not, the copy will be aborted.

Implementations

impl BinaryCopyInWriter

pub fn new(sink: CopyInSink<Bytes>, types: &[Type]) -> BinaryCopyInWriter

Creates a new writer which will write rows of the provided types to the provided sink.

pub async fn write( self: Pin<&mut Self>, values: &[&(dyn ToSql + Sync)], ) -> Result<(), Error>

Writes a single row.

Panics

Panics if the number of values provided does not match the number expected.

pub async fn write_raw<P, I>( self: Pin<&mut Self>, values: I, ) -> Result<(), Error>

where P: BorrowToSql, I: IntoIterator<Item = P>, I::IntoIter: ExactSizeIterator,

A maximally-flexible version of write.

Panics

Panics if the number of values provided does not match the number expected.

pub async fn finish(self: Pin<&mut Self>) -> Result<u64, Error>

Completes the copy, returning the number of rows added.

This method must be used to complete the copy process. If it is not, the copy will be aborted.

Trait Implementations

impl<'__pin> Unpin for BinaryCopyInWriter

where PinnedFieldsOf<__Origin<'__pin>>: Unpin,