Struct tokio_postgres::CopyInSink

pub struct CopyInSink<T> { /* private fields */ }

A sink for COPY ... FROM STDIN query data.

The copy must be explicitly completed via the Sink::close or finish methods. If it is not, the copy will be aborted.

Implementations

impl<T> CopyInSink<T>

where T: Buf + 'static + Send,

pub fn poll_finish( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<u64, Error>>

A poll-based version of finish.

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

Completes the copy, returning the number of rows inserted.

The Sink::close method is equivalent to finish, except that it does not return the number of rows.

Trait Implementations

impl<T> Sink<T> for CopyInSink<T>

where T: Buf + 'static + Send,

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Flush any remaining output and close this sink, if necessary.

impl<'__pin, T> Unpin for CopyInSink<T>

where __Origin<'__pin, T>: Unpin,