Struct polars_arrow::io::ipc::write::Record

pub struct Record<'a> { /* private fields */ }

Available on crate feature io_ipc only.

An array RecordBatchT with optional accompanying IPC fields.

Implementations

impl<'a> Record<'a>

pub fn fields(&self) -> Option<&[IpcField]>

Get the IPC fields for this record.

pub fn columns(&self) -> &RecordBatchT<Box<dyn Array>>

Get the Arrow columns in this record.

Trait Implementations

impl<'a> Clone for Record<'a>

fn clone(&self) -> Record<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Record<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, F> From<(&'a RecordBatchT<Box<dyn Array>>, Option<F>)> for Record<'a>

where F: Into<Cow<'a, [IpcField]>>,

fn from( (columns, fields): (&'a RecordBatchT<Box<dyn Array>>, Option<F>), ) -> Self

Converts to this type from the input type.

impl<'a, F> From<(RecordBatchT<Box<dyn Array>>, Option<F>)> for Record<'a>

where F: Into<Cow<'a, [IpcField]>>,

fn from((columns, fields): (RecordBatchT<Box<dyn Array>>, Option<F>)) -> Self

Converts to this type from the input type.

impl From<RecordBatchT<Box<dyn Array>>> for Record<'static>

fn from(columns: RecordBatchT<Box<dyn Array>>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Record<'a>

fn eq(&self, other: &Record<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, W> Sink<Record<'_>> for FileSink<'a, W>

where W: AsyncWrite + Unpin + Send + 'a,

Available on crate feature io_ipc_write_async only.

type Error = PolarsError

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

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

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Record<'_>) -> PolarsResult<()>

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<PolarsResult<()>>

Flush any remaining output from this sink.

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

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

impl<'a, W> Sink<Record<'_>> for StreamSink<'a, W>

where W: AsyncWrite + Unpin + Send,

Available on crate feature io_ipc_write_async only.

type Error = PolarsError

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

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

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Record<'_>) -> PolarsResult<()>

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<PolarsResult<()>>

Flush any remaining output from this sink.

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

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

impl<'a> StructuralPartialEq for Record<'a>