Struct GTableSink 

pub struct GTableSink<W, B>
where
    W: AsyncWrite + Unpin + Send + Sync + 'static,
    B: StreamBuffer + Unpin + 'static,
{ /* private fields */ }

Generic asynchronous Arrow Table sink for Tokio and other async runtimes.

This wraps any compatible async byte sink (W: AsyncWrite) and handles Arrow IPC protocol (framing, schema, dictionaries, record batches, footers).

It yields whole Table objects and is the recommended sink for Minarrow data. Tables it yields are analogous with Apache Arrow Record Batches once written into the wider ecosystem.

Implementations

impl<W, B> GTableSink<W, B>

where W: AsyncWrite + Unpin + Send + Sync + 'static, B: StreamBuffer + Debug + Unpin + 'static,

pub fn new( sink: W, schema: Vec<Field>, protocol: IPCMessageProtocol, compression: Option<Compression>, ) -> Result<Self>

Create a new generic Arrow Table writer. Pass None for compression to write uncompressed batches; Some(codec) compresses every record-batch body.

pub fn sink_mut(&mut self) -> &mut W

Expose a mutable reference to the inner sink.

Trait Implementations

impl<W, B> Sink<TableV> for GTableSink<W, B>

where W: AsyncWrite + Unpin + Send + Sync + 'static, B: StreamBuffer + Debug + Unpin + 'static,

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

Admit a new table once the pending frame has reached the sink.

type Error = Error

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

fn start_send(self: Pin<&mut Self>, view: TableV) -> Result<(), Self::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<()>>

Flush any remaining output from this sink.

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

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