polars::prelude

Struct Scalar

pub struct Scalar { /* private fields */ }

Implementations§

impl Scalar

pub fn new_date(value: i32) -> Scalar

pub fn new_datetime( value: i64, time_unit: TimeUnit, tz: Option<TimeZone>, ) -> Scalar

pub fn new_duration(value: i64, time_unit: TimeUnit) -> Scalar

pub fn new_time(value: i64) -> Scalar

pub fn new_list(values: Series) -> Scalar

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

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

pub fn new_enum( value: u32, categories: &BinaryViewArrayGeneric<str>, ) -> Result<Scalar, PolarsError>

pub fn new_categorical( value: &str, name: PlSmallStr, namespace: PlSmallStr, physical: CategoricalPhysical, ) -> Result<Scalar, PolarsError>

impl Scalar

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

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

pub fn new_idxsize(value: u32) -> Scalar

pub fn cast_with_options( self, dtype: &DataType, options: CastOptions, ) -> Result<Scalar, PolarsError>

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

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. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Scalar

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

Formats the value using the given formatter. Read more

impl Default for Scalar

fn default() -> Scalar

Returns the “default value” for a type. Read more

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

fn deserialize<D>( deserializer: D, ) -> Result<Scalar, <D as Deserializer<'a>>::Error>
where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer. Read more

impl From<PlSmallStr> for Scalar

fn from(v: PlSmallStr) -> Scalar

Converts to this type from the input type.

impl From<Scalar> for LiteralValue

fn from(value: Scalar) -> LiteralValue

Converts to this type from the input type.

impl From<Vec<u8>> for Scalar

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

Converts to this type from the input type.

impl From<bool> for Scalar

fn from(v: bool) -> Scalar

Converts to this type from the input type.

impl From<f32> for Scalar

fn from(v: f32) -> Scalar

Converts to this type from the input type.

impl From<f64> for Scalar

fn from(v: f64) -> Scalar

Converts to this type from the input type.

impl From<i128> for Scalar

fn from(v: i128) -> Scalar

Converts to this type from the input type.

impl From<i16> for Scalar

fn from(v: i16) -> Scalar

Converts to this type from the input type.

impl From<i32> for Scalar

fn from(v: i32) -> Scalar

Converts to this type from the input type.

impl From<i64> for Scalar

fn from(v: i64) -> Scalar

Converts to this type from the input type.

impl From<i8> for Scalar

fn from(v: i8) -> Scalar

Converts to this type from the input type.

impl From<u16> for Scalar

fn from(v: u16) -> Scalar

Converts to this type from the input type.

impl From<u32> for Scalar

fn from(v: u32) -> Scalar

Converts to this type from the input type.

impl From<u64> for Scalar

fn from(v: u64) -> Scalar

Converts to this type from the input type.

impl From<u8> for Scalar

fn from(v: u8) -> Scalar

Converts to this type from the input type.

impl Hash for Scalar

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl Literal for Scalar

fn lit(self) -> Expr

Literal expression.

impl PartialEq for Scalar

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

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

1.0.0 · Source§

const 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

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

Serialize this value into the given Serde serializer. Read more

impl TryFrom<SerializableScalar> for Scalar

type Error = PolarsError

The type returned in the event of a conversion error.

fn try_from( value: SerializableScalar, ) -> Result<Scalar, <Scalar as TryFrom<SerializableScalar>>::Error>

Performs the conversion.

impl StructuralPartialEq for Scalar

Auto Trait Implementations§

impl Freeze for Scalar

impl !RefUnwindSafe for Scalar

impl Send for Scalar

impl Sync for Scalar

impl Unpin for Scalar

impl !UnwindSafe for Scalar

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Key for T
where T: Clone,

fn align() -> usize

The alignment necessary for the key. Must return a power of two.

fn size(&self) -> usize

The size of the key in bytes.

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> PlanCallbackArgs for T

impl<T> PlanCallbackOut for T