Enum polars::datatypes::DataType

source ·
pub enum DataType {
Show 27 variants Boolean, UInt8, UInt16, UInt32, UInt64, Int8, Int16, Int32, Int64, Float32, Float64, Decimal(Option<usize>, Option<usize>), String, Binary, BinaryOffset, Date, Datetime(TimeUnit, Option<String>), Duration(TimeUnit), Time, Array(Box<DataType>, usize), List(Box<DataType>), Object(&'static str, Option<Arc<ObjectRegistry>>), Null, Categorical(Option<Arc<RevMapping>>, CategoricalOrdering), Enum(Option<Arc<RevMapping>>, CategoricalOrdering), Struct(Vec<Field>), Unknown(UnknownKind),
}

Variants§

§

Boolean

§

UInt8

§

UInt16

§

UInt32

§

UInt64

§

Int8

§

Int16

§

Int32

§

Int64

§

Float32

§

Float64

§

Decimal(Option<usize>, Option<usize>)

Available on crate feature dtype-decimal only.

Fixed point decimal type optional precision and non-negative scale. This is backed by a signed 128-bit integer which allows for up to 38 significant digits. Meaning max precision is 38.

§

String

String data

§

Binary

§

BinaryOffset

§

Date

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

§

Datetime(TimeUnit, Option<String>)

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

§

Duration(TimeUnit)

§

Time

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

§

Array(Box<DataType>, usize)

Available on crate feature dtype-array only.

A nested list with a fixed size in each row

§

List(Box<DataType>)

A nested list with a variable size in each row

§

Object(&'static str, Option<Arc<ObjectRegistry>>)

Available on crate feature object only.

A generic type that can be used in a Series &’static str can be used to determine/set inner type

§

Null

§

Categorical(Option<Arc<RevMapping>>, CategoricalOrdering)

Available on crate feature dtype-categorical only.
§

Enum(Option<Arc<RevMapping>>, CategoricalOrdering)

Available on crate feature dtype-categorical only.
§

Struct(Vec<Field>)

Available on crate feature dtype-struct only.
§

Unknown(UnknownKind)

Implementations§

source§

impl DataType

source

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

source

pub fn is_known(&self) -> bool

Check if the whole dtype is known.

source

pub fn get_shape(&self) -> Option<Vec<usize>>

Available on crate feature dtype-array only.

Get the full shape of a multidimensional array.

source

pub fn inner_dtype(&self) -> Option<&DataType>

Get the inner data type of a nested type.

source

pub fn leaf_dtype(&self) -> &DataType

Get the absolute inner data type of a nested type.

source

pub fn cast_leaf(&self, to: DataType) -> DataType

Cast the leaf types of Lists/Arrays and keep the nesting.

source

pub fn implode(self) -> DataType

source

pub fn to_physical(&self) -> DataType

Convert to the physical data type

source

pub fn is_logical(&self) -> bool

Check if this DataType is a logical type

source

pub fn is_temporal(&self) -> bool

Check if this DataType is a temporal type

source

pub fn is_primitive(&self) -> bool

Check if datatype is a primitive type. By that we mean that it is not a container type.

source

pub fn is_numeric(&self) -> bool

Check if this DataType is a basic numeric type (excludes Decimal).

source

pub fn is_bool(&self) -> bool

Check if this DataType is a boolean.

source

pub fn is_list(&self) -> bool

Check if this DataType is a list.

source

pub fn is_array(&self) -> bool

Check if this DataType is an array.

source

pub fn is_nested(&self) -> bool

source

pub fn is_struct(&self) -> bool

Check if this DataType is a struct

source

pub fn is_binary(&self) -> bool

source

pub fn is_object(&self) -> bool

source

pub fn is_null(&self) -> bool

source

pub fn contains_views(&self) -> bool

source

pub fn contains_categoricals(&self) -> bool

source

pub fn contains_objects(&self) -> bool

source

pub fn is_ord(&self) -> bool

Check if type is sortable

source

pub fn is_decimal(&self) -> bool

Check if this DataType is a Decimal type (of any scale/precision).

source

pub fn is_float(&self) -> bool

Check if this DataType is a basic floating point type (excludes Decimal).

source

pub fn is_integer(&self) -> bool

Check if this DataType is an integer.

source

pub fn is_signed_integer(&self) -> bool

source

pub fn is_unsigned_integer(&self) -> bool

source

pub fn is_string(&self) -> bool

source

pub fn is_categorical(&self) -> bool

source

pub fn is_enum(&self) -> bool

source

pub fn to_arrow_field(&self, name: &str, compat_level: CompatLevel) -> Field

Convert to an Arrow Field

source

pub fn to_arrow(&self, compat_level: CompatLevel) -> ArrowDataType

Convert to an Arrow data type.

source

pub fn try_to_arrow( &self, compat_level: CompatLevel, ) -> Result<ArrowDataType, PolarsError>

source

pub fn is_nested_null(&self) -> bool

source

pub fn matches_schema_type( &self, schema_type: &DataType, ) -> Result<bool, PolarsError>

source§

impl DataType

source

pub fn boxed(self) -> Box<DataType>

source

pub fn from_arrow(dt: &ArrowDataType, bin_to_view: bool) -> DataType

Trait Implementations§

source§

impl AsRef<DataType> for DataType

source§

fn as_ref(&self) -> &DataType

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<DataType> for Field

source§

fn as_ref(&self) -> &DataType

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Clone for DataType

source§

fn clone(&self) -> DataType

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for DataType

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for DataType

source§

fn default() -> DataType

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

impl Display for DataType

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<&ArrowDataType> for DataType

source§

fn from(dt: &ArrowDataType) -> DataType

Converts to this type from the input type.
source§

impl From<AnyValue<'_>> for DataType

source§

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

Converts to this type from the input type.
source§

impl Hash for DataType

source§

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
source§

impl PartialEq<ArrowDataType> for DataType

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq for DataType

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl Eq for DataType

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

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

source§

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

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoEither for T

source§

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
source§

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> 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
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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