Struct polars_core::datatypes::StructChunked

pub struct StructChunked { /* private fields */ }

Available on crate feature dtype-struct only.

This is logical type StructChunked that dispatches most logic to the fields implementations

Different from StructArray, this type does not have its own validity. That means some operations will be a bit less efficient because we need to check validity of all fields. However this does save a lot of code and compile times.

Implementations

impl StructChunked

pub fn new(name: &str, fields: &[Series]) -> PolarsResult<Self>

pub fn rechunk(&mut self)

pub fn field_by_name(&self, name: &str) -> PolarsResult<Series>

Get access to one of this [StructChunked]’s fields

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn ref_field(&self) -> &Field

Get a reference to the Field of array.

pub fn name(&self) -> &String

pub fn fields(&self) -> &[Series]

pub fn fields_mut(&mut self) -> &mut Vec<Series>

pub fn rename(&mut self, name: &str)

Trait Implementations

impl AggList for StructChunked

unsafe fn agg_list(&self, groups: &GroupsProxy) -> Series

Safety

impl ChunkCompare<&StructChunked> for StructChunked

type Item = ChunkedArray<BooleanType>

fn equal(&self, rhs: &StructChunked) -> BooleanChunked

Check for equality.

fn not_equal(&self, rhs: &StructChunked) -> BooleanChunked

Check for inequality.

fn gt(&self, _rhs: &StructChunked) -> BooleanChunked

Greater than comparison.

fn gt_eq(&self, _rhs: &StructChunked) -> BooleanChunked

Greater than or equal comparison.

fn lt(&self, _rhs: &StructChunked) -> BooleanChunked

Less than comparison.

fn lt_eq(&self, _rhs: &StructChunked) -> BooleanChunked

Less than or equal comparison

impl Clone for StructChunked

fn clone(&self) -> StructChunked

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for StructChunked

Available on crate feature object only.

fn drop(&mut self)

Executes the destructor for this type.

impl From<StructChunked> for DataFrame

fn from(ca: StructChunked) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a StructChunked

type Item = &'a [AnyValue<'a>]

The type of the elements being iterated over.

type IntoIter = StructIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoSeries for StructChunked

fn into_series(self) -> Series

fn is_series() -> bool

impl IsIn for StructChunked

Available on crate feature is_in only.

fn is_in(&self, other: &Series) -> PolarsResult<BooleanChunked>

Check if elements of this array are in the right Series, or List values of the right Series.

impl LogicalType for StructChunked

fn get_any_value(&self, i: usize) -> PolarsResult<AnyValue<'_>>

Gets AnyValue from LogicalType

fn dtype(&self) -> &DataType

Get data type of ChunkedArray.

unsafe fn get_any_value_unchecked(&self, i: usize) -> AnyValue<'_>

Safety

fn cast(&self, dtype: &DataType) -> PolarsResult<Series>