Struct Scalar 

pub struct Scalar { /* private fields */ }

Implementations

impl Scalar

pub fn new_list(values: Series) -> Self

pub fn new_array(values: Series, width: usize) -> Self

Available on crate feature dtype-array only.

pub fn new_decimal(value: i128, scale: usize) -> Self

Available on crate feature dtype-decimal only.

pub fn new_enum( value: CatSize, categories: &Utf8ViewArray, ) -> PolarsResult<Self>

Available on crate feature dtype-categorical only.

pub fn new_categorical( value: &str, name: PlSmallStr, namespace: PlSmallStr, physical: CategoricalPhysical, ) -> PolarsResult<Self>

Available on crate feature dtype-categorical only.

impl Scalar

pub const fn new(dtype: DataType, value: AnyValue<'static>) -> Self

pub const fn null(dtype: DataType) -> Self

pub fn new_idxsize(value: IdxSize) -> Self

pub fn cast_with_options( self, dtype: &DataType, options: CastOptions, ) -> PolarsResult<Self>

pub fn is_null(&self) -> bool

pub fn is_nan(&self) -> bool

pub fn into_value(self) -> AnyValue<'static>

pub fn value(&self) -> &AnyValue<'static>

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

pub fn into_series(self, name: PlSmallStr) -> Series

pub fn into_column(self, name: PlSmallStr) -> Column

Turn a scalar into a column with length=1.

pub fn dtype(&self) -> &DataType

pub fn update(&mut self, value: AnyValue<'static>)

pub fn with_value(self, value: AnyValue<'static>) -> Self

pub fn any_value_mut(&mut self) -> &mut AnyValue<'static>

pub fn to_physical(self) -> Scalar

Trait Implementations

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scalar

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

Formats the value using the given formatter.

impl Default for Scalar

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Deserialize<'a> for Scalar

Available on (crate features serde or dsl-schema) and crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer.

impl From<PlSmallStr> for Scalar

fn from(v: PlSmallStr) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Scalar

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<bool> for Scalar

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Scalar

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Scalar

fn from(v: f64) -> Self

Converts to this type from the input type.

impl From<i128> for Scalar

fn from(v: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Scalar

fn from(v: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Scalar

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Scalar

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Scalar

fn from(v: i8) -> Self

Converts to this type from the input type.

impl From<u16> for Scalar

fn from(v: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Scalar

fn from(v: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Scalar

fn from(v: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Scalar

fn from(v: u8) -> Self

Converts to this type from the input type.

impl Hash for Scalar

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

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 Scalar

fn eq(&self, other: &Scalar) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Scalar

Available on (crate features serde or dsl-schema) and crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Scalar