Struct polars::datatypes::StructChunked

pub struct StructChunked { /* private fields */ }

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 null_count(&self) -> usize

pub fn total_null_count(&self) -> usize

pub fn new(name: &str, fields: &[Series]) -> Result<StructChunked, PolarsError>

pub fn chunks(&self) -> &Vec<Box<dyn Array>>

pub fn rechunk(&mut self)

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

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) -> &SmartString<LazyCompact>

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

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

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

pub fn _apply_fields<F>(&self, func: F) -> StructChunked

where F: FnMut(&Series) -> Series,

pub fn unnest(self) -> DataFrame

pub fn rows_encode(&self) -> Result<ChunkedArray<BinaryOffsetType>, PolarsError>

pub fn iter(&self) -> StructIter<'_>

Trait Implementations

impl AggList for StructChunked

Available on crate feature dtype-struct only.

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

Safety

impl ChunkCompare<&StructChunked> for StructChunked

Available on crate feature dtype-struct only.

type Item = ChunkedArray<BooleanType>

fn equal(&self, rhs: &StructChunked) -> ChunkedArray<BooleanType>

Check for equality.

fn equal_missing(&self, rhs: &StructChunked) -> ChunkedArray<BooleanType>

Check for equality where None == None.

fn not_equal(&self, rhs: &StructChunked) -> ChunkedArray<BooleanType>

Check for inequality.

fn not_equal_missing(&self, rhs: &StructChunked) -> ChunkedArray<BooleanType>

Check for inequality where None == None.

fn gt(&self, _rhs: &StructChunked) -> ChunkedArray<BooleanType>

Greater than comparison.

fn gt_eq(&self, _rhs: &StructChunked) -> ChunkedArray<BooleanType>

Greater than or equal comparison.

fn lt(&self, _rhs: &StructChunked) -> ChunkedArray<BooleanType>

Less than comparison.

fn lt_eq(&self, _rhs: &StructChunked) -> ChunkedArray<BooleanType>

Less than or equal comparison

impl ChunkFullNull for StructChunked

Available on crate feature dtype-struct only.

fn full_null(name: &str, length: usize) -> StructChunked

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) -> DataFrame

Converts to this type from the input type.

impl<'a> IntoIterator for &'a StructChunked

Available on crate feature dtype-struct only.

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) -> <&'a StructChunked as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoSeries for StructChunked

fn into_series(self) -> Series

fn is_series() -> bool

impl LogicalType for StructChunked

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

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_with_options( &self, dtype: &DataType, cast_options: CastOptions ) -> Result<Series, PolarsError>

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