polars_arrow::ffi

Struct ArrowArrayStreamReader

Source 
pub struct ArrowArrayStreamReader<Iter: DerefMut<Target = ArrowArrayStream>> { /* private fields */ }
Expand description

Implements an iterator of Array consumed from the C stream interface.

Implementations§

Source§

impl<Iter: DerefMut<Target = ArrowArrayStream>> ArrowArrayStreamReader<Iter>

Source

pub unsafe fn try_new(iter: Iter) -> PolarsResult<Self>

Returns a new ArrowArrayStreamReader

§Error

Errors iff the ArrowArrayStream is out of specification, or was already released prior to calling this function.

§Safety

This method is intrinsically unsafe since it assumes that the ArrowArrayStream contains a valid Arrow C stream interface. In particular:

  • The ArrowArrayStream fulfills the invariants of the C stream interface
  • The schema get_schema produces fulfills the C data interface
Source

pub fn field(&self) -> &Field

Returns the field provided by the stream

Source

pub unsafe fn next(&mut self) -> Option<PolarsResult<Box<dyn Array>>>

Advances this iterator by one array

§Error

Errors iff:

  • The C stream interface returns an error
  • The C stream interface returns an invalid array (that we can identify, see Safety below)
§Safety

Calling this iterator’s next assumes that the ArrowArrayStream produces arrow arrays that fulfill the C data interface

Auto Trait Implementations§

§

impl<Iter> Freeze for ArrowArrayStreamReader<Iter>
where Iter: Freeze,

§

impl<Iter> RefUnwindSafe for ArrowArrayStreamReader<Iter>
where Iter: RefUnwindSafe,

§

impl<Iter> Send for ArrowArrayStreamReader<Iter>
where Iter: Send,

§

impl<Iter> Sync for ArrowArrayStreamReader<Iter>
where Iter: Sync,

§

impl<Iter> Unpin for ArrowArrayStreamReader<Iter>
where Iter: Unpin,

§

impl<Iter> UnwindSafe for ArrowArrayStreamReader<Iter>
where Iter: 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.