Struct polars_arrow::scalar::DictionaryScalar

pub struct DictionaryScalar<K: DictionaryKey> { /* private fields */ }

The DictionaryArray equivalent of Array for Scalar.

Implementations

impl<K: DictionaryKey> DictionaryScalar<K>

pub fn new(data_type: ArrowDataType, value: Option<Box<dyn Scalar>>) -> Self

returns a new DictionaryScalar

Panics

iff

• the data_type is not List or LargeList (depending on this scalar’s offset O)
• the child of the data_type is not equal to the values

pub fn value(&self) -> Option<&Box<dyn Scalar>>

The values of the DictionaryScalar

Trait Implementations

impl<K: Clone + DictionaryKey> Clone for DictionaryScalar<K>

fn clone(&self) -> DictionaryScalar<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + DictionaryKey> Debug for DictionaryScalar<K>

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

Formats the value using the given formatter.

impl<K: DictionaryKey> PartialEq for DictionaryScalar<K>

fn eq(&self, other: &Self) -> 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<K: DictionaryKey> Scalar for DictionaryScalar<K>

fn as_any(&self) -> &dyn Any

convert itself to

fn is_valid(&self) -> bool

whether it is valid

fn data_type(&self) -> &ArrowDataType

the logical type.