polars_arrow_format::ipc

Struct RecordBatchBuilder

Source 
pub struct RecordBatchBuilder<State>(/* private fields */);
Expand description

Builder for serializing an instance of the RecordBatch type.

Can be created using the RecordBatch::builder method.

Implementations§

Source§

impl RecordBatchBuilder<()>

Source

pub fn length<T0>(self, value: T0) -> RecordBatchBuilder<(T0,)>
where T0: WriteAsDefault<i64, i64>,

Setter for the length field.

Source

pub fn length_as_default(self) -> RecordBatchBuilder<(DefaultValue,)>

Sets the length field to the default value.

Source§

impl<T0> RecordBatchBuilder<(T0,)>

Source

pub fn nodes<T1>(self, value: T1) -> RecordBatchBuilder<(T0, T1)>
where T1: WriteAsOptional<Offset<[FieldNode]>>,

Setter for the nodes field.

Source

pub fn nodes_as_null(self) -> RecordBatchBuilder<(T0, ())>

Sets the nodes field to null.

Source§

impl<T0, T1> RecordBatchBuilder<(T0, T1)>

Source

pub fn buffers<T2>(self, value: T2) -> RecordBatchBuilder<(T0, T1, T2)>
where T2: WriteAsOptional<Offset<[Buffer]>>,

Setter for the buffers field.

Source

pub fn buffers_as_null(self) -> RecordBatchBuilder<(T0, T1, ())>

Sets the buffers field to null.

Source§

impl<T0, T1, T2> RecordBatchBuilder<(T0, T1, T2)>

Source

pub fn compression<T3>(self, value: T3) -> RecordBatchBuilder<(T0, T1, T2, T3)>
where T3: WriteAsOptional<Offset<BodyCompression>>,

Setter for the compression field.

Source

pub fn compression_as_null(self) -> RecordBatchBuilder<(T0, T1, T2, ())>

Sets the compression field to null.

Source§

impl<T0, T1, T2, T3> RecordBatchBuilder<(T0, T1, T2, T3)>

Source

pub fn variadic_buffer_counts<T4>( self, value: T4, ) -> RecordBatchBuilder<(T0, T1, T2, T3, T4)>
where T4: WriteAsOptional<Offset<[i64]>>,

Setter for the variadicBufferCounts field.

Source

pub fn variadic_buffer_counts_as_null( self, ) -> RecordBatchBuilder<(T0, T1, T2, T3, ())>

Sets the variadicBufferCounts field to null.

Source§

impl<T0, T1, T2, T3, T4> RecordBatchBuilder<(T0, T1, T2, T3, T4)>

Source

pub fn finish(self, builder: &mut Builder) -> Offset<RecordBatch>
where Self: WriteAsOffset<RecordBatch>,

Finish writing the builder to get an Offset to a serialized RecordBatch.

Trait Implementations§

Auto Trait Implementations§

§

impl<State> Freeze for RecordBatchBuilder<State>
where State: Freeze,

§

impl<State> RefUnwindSafe for RecordBatchBuilder<State>
where State: RefUnwindSafe,

§

impl<State> Send for RecordBatchBuilder<State>
where State: Send,

§

impl<State> Sync for RecordBatchBuilder<State>
where State: Sync,

§

impl<State> Unpin for RecordBatchBuilder<State>
where State: Unpin,

§

impl<State> UnwindSafe for RecordBatchBuilder<State>
where State: UnwindSafe,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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

Source§

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.