Enum polars::prelude::AnyValue

pub enum AnyValue<'a> {
    Null,
    Boolean(bool),
    String(&'a str),
    UInt8(u8),
    UInt16(u16),
    UInt32(u32),
    UInt64(u64),
    Int8(i8),
    Int16(i16),
    Int32(i32),
    Int64(i64),
    Float32(f32),
    Float64(f64),
    Date(i32),
    Datetime(i64, TimeUnit, &'a Option<String>),
    Duration(i64, TimeUnit),
    Time(i64),
    Categorical(u32, &'a RevMapping, SyncPtr<BinaryViewArrayGeneric<str>>),
    Enum(u32, &'a RevMapping, SyncPtr<BinaryViewArrayGeneric<str>>),
    List(Series),
    Array(Series, usize),
    Object(&'a (dyn PolarsObjectSafe + 'static)),
    ObjectOwned(OwnedObject),
    Struct(usize, &'a StructArray, &'a [Field]),
    StructOwned(Box<(Vec<AnyValue<'a>>, Vec<Field>)>),
    StringOwned(SmartString<LazyCompact>),
    Binary(&'a [u8]),
    BinaryOwned(Vec<u8>),
    Decimal(i128, usize),
}

Variants

Null

Boolean(bool)

A binary true or false.

String(&'a str)

A UTF8 encoded string type.

UInt8(u8)

An unsigned 8-bit integer number.

UInt16(u16)

An unsigned 16-bit integer number.

UInt32(u32)

An unsigned 32-bit integer number.

UInt64(u64)

An unsigned 64-bit integer number.

Int8(i8)

An 8-bit integer number.

Int16(i16)

A 16-bit integer number.

Int32(i32)

A 32-bit integer number.

Int64(i64)

A 64-bit integer number.

Float32(f32)

A 32-bit floating point number.

Float64(f64)

A 64-bit floating point number.

Date(i32)

Available on crate feature dtype-date only.

A 32-bit date representing the elapsed time since UNIX epoch (1970-01-01) in days (32 bits).

Datetime(i64, TimeUnit, &'a Option<String>)

Available on crate feature dtype-datetime only.

A 64-bit date representing the elapsed time since UNIX epoch (1970-01-01) in nanoseconds (64 bits).

Duration(i64, TimeUnit)

Available on crate feature dtype-duration only.

Time(i64)

Available on crate feature dtype-time only.

A 64-bit time representing the elapsed time since midnight in nanoseconds

Categorical(u32, &'a RevMapping, SyncPtr<BinaryViewArrayGeneric<str>>)

Available on crate feature dtype-categorical only.

Enum(u32, &'a RevMapping, SyncPtr<BinaryViewArrayGeneric<str>>)

Available on crate feature dtype-categorical only.

List(Series)

Nested type, contains arrays that are filled with one of the datatypes.

Array(Series, usize)

Available on crate feature dtype-array only.

Object(&'a (dyn PolarsObjectSafe + 'static))

Available on crate feature object only.

Can be used to fmt and implements Any, so can be downcasted to the proper value type.

ObjectOwned(OwnedObject)

Available on crate feature object only.

Struct(usize, &'a StructArray, &'a [Field])

Available on crate feature dtype-struct only.

StructOwned(Box<(Vec<AnyValue<'a>>, Vec<Field>)>)

Available on crate feature dtype-struct only.

StringOwned(SmartString<LazyCompact>)

An UTF8 encoded string type.

Binary(&'a [u8])

BinaryOwned(Vec<u8>)

Decimal(i128, usize)

Available on crate feature dtype-decimal only.

A 128-bit fixed point decimal number.

Implementations

impl<'a> AnyValue<'a>

pub fn _iter_struct_av(&self) -> impl Iterator<Item = AnyValue<'_>>

Available on crate feature dtype-struct only.

pub fn _materialize_struct_av(&'a self, buf: &mut Vec<AnyValue<'a>>)

Available on crate feature dtype-struct only.

impl AnyValue<'static>

pub fn zero(dtype: &DataType) -> AnyValue<'static>

impl<'a> AnyValue<'a>

pub fn dtype(&self) -> DataType

Get the matching DataType for this AnyValue`.

Note: For Categorical and Enum values, the exact mapping information is not preserved in the result for performance reasons.

pub fn try_extract<T>(&self) -> Result<T, PolarsError>

where T: NumCast,

pub fn is_boolean(&self) -> bool

pub fn is_numeric(&self) -> bool

pub fn is_float(&self) -> bool

pub fn is_integer(&self) -> bool

pub fn is_signed_integer(&self) -> bool

pub fn is_unsigned_integer(&self) -> bool

pub fn is_null(&self) -> bool

pub fn is_nested_null(&self) -> bool

pub fn strict_cast(&self, dtype: &'a DataType) -> Option<AnyValue<'a>>

Cast AnyValue to the provided data type and return a new AnyValue with type dtype, if possible.

pub fn try_strict_cast( &self, dtype: &'a DataType ) -> Result<AnyValue<'a>, PolarsError>

Cast AnyValue to the provided data type and return a new AnyValue with type dtype, if possible.

pub fn cast(&self, dtype: &'a DataType) -> AnyValue<'a>

impl AnyValue<'_>

pub fn hash_impl<H>(&self, state: &mut H, cheap: bool)

where H: Hasher,

impl<'a> AnyValue<'a>

pub fn add(&self, rhs: &AnyValue<'_>) -> AnyValue<'static>

pub fn as_borrowed(&self) -> AnyValue<'_>

pub fn into_static(self) -> Result<AnyValue<'static>, PolarsError>

Try to coerce to an AnyValue with static lifetime. This can be done if it does not borrow any values.

pub fn get_str(&self) -> Option<&str>

Get a reference to the &str contained within AnyValue.

impl AnyValue<'_>

pub fn eq_missing(&self, other: &AnyValue<'_>, null_equal: bool) -> bool

Trait Implementations

impl<'a> Clone for AnyValue<'a>

fn clone(&self) -> AnyValue<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AnyValue<'a>

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

Formats the value using the given formatter.

impl<'a> Default for AnyValue<'a>

fn default() -> AnyValue<'a>

Returns the “default value” for a type.

impl Display for AnyValue<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for AnyValue<'a>

fn from(value: &'a [u8]) -> AnyValue<'a>

Converts to this type from the input type.

impl From<&AnyValue<'_>> for NaiveDateTime

fn from(v: &AnyValue<'_>) -> NaiveDateTime

Converts to this type from the input type.

impl From<&AnyValue<'_>> for NaiveTime

fn from(v: &AnyValue<'_>) -> NaiveTime

Converts to this type from the input type.

impl<'a> From<&AnyValue<'a>> for DataType

fn from(value: &AnyValue<'a>) -> DataType

Converts to this type from the input type.

impl<'a> From<&AnyValue<'a>> for Field

fn from(val: &AnyValue<'a>) -> Field

Converts to this type from the input type.

impl<'a> From<&'a str> for AnyValue<'a>

fn from(value: &'a str) -> AnyValue<'a>

Converts to this type from the input type.

impl From<AnyValue<'_>> for DataType

fn from(value: AnyValue<'_>) -> DataType

Converts to this type from the input type.

impl<'a> From<AnyValue<'a>> for Option<i64>

fn from(val: AnyValue<'a>) -> Option<i64>

Converts to this type from the input type.

impl<K> From<K> for AnyValue<'static>

where K: NumericNative,

fn from(value: K) -> AnyValue<'static>

Converts to this type from the input type.

impl<'a, T> From<Option<T>> for AnyValue<'a>

where T: Into<AnyValue<'a>>,

fn from(a: Option<T>) -> AnyValue<'a>

Converts to this type from the input type.

impl From<bool> for AnyValue<'static>

fn from(value: bool) -> AnyValue<'static>

Converts to this type from the input type.

impl<'a> Hash for AnyValue<'a>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AnyValue<'_>

fn eq(&self, other: &AnyValue<'_>) -> 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 PartialOrd for AnyValue<'_>

fn partial_cmp(&self, other: &AnyValue<'_>) -> Option<Ordering>

Only implemented for the same types and physical types!

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TotalEq for AnyValue<'_>

fn tot_eq(&self, other: &AnyValue<'_>) -> bool

fn tot_ne(&self, other: &Self) -> bool

impl TryFrom<AnyValue<'_>> for LiteralValue

type Error = PolarsError

The type returned in the event of a conversion error.

fn try_from(value: AnyValue<'_>) -> Result<LiteralValue, PolarsError>

Performs the conversion.

impl<'a> Eq for AnyValue<'a>