Struct tokio_postgres::binary_copy::BinaryCopyInWriter

source ·
pub struct BinaryCopyInWriter { /* private fields */ }
Expand description

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§

source§

impl BinaryCopyInWriter

source

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.

source

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.

source

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.

source

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§

source§

impl<'__pin> Unpin for BinaryCopyInWriter
where __Origin<'__pin>: Unpin,

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

§

type Output = T

Should always be Self
source§

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

§

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

§

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