Struct polars_core::schema::Schema

pub struct Schema { /* private fields */ }

Implementations

impl Schema

pub fn try_from_fallible<I>(flds: I) -> PolarsResult<Self>where I: IntoIterator<Item = PolarsResult<Field>>,

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn rename(&mut self, old: &str, new: String) -> Option<()>

pub fn insert_index( &self, index: usize, name: String, dtype: DataType ) -> Option<Self>

pub fn get(&self, name: &str) -> Option<&DataType>

pub fn try_get(&self, name: &str) -> PolarsResult<&DataType>

pub fn try_get_full( &self, name: &str ) -> PolarsResult<(usize, &String, &DataType)>

pub fn remove(&mut self, name: &str) -> Option<DataType>

pub fn get_full(&self, name: &str) -> Option<(usize, &String, &DataType)>

pub fn get_field(&self, name: &str) -> Option<Field>

pub fn try_get_field(&self, name: &str) -> PolarsResult<Field>

pub fn get_index(&self, index: usize) -> Option<(&String, &DataType)>

pub fn contains(&self, name: &str) -> bool

pub fn get_index_mut( &mut self, index: usize ) -> Option<(&mut String, &mut DataType)>

pub fn coerce_by_name(&mut self, name: &str, dtype: DataType) -> Option<()>

pub fn coerce_by_index(&mut self, index: usize, dtype: DataType) -> Option<()>

pub fn with_column(&mut self, name: String, dtype: DataType) -> Option<DataType>

Insert a new column in the Schema

If an equivalent name already exists in the schema: the name remains and retains in its place in the order, its corresponding value is updated with DataType and the older dtype is returned inside Some(_).

If no equivalent key existed in the map: the new name-dtype pair is inserted, last in order, and None is returned.

Computes in O(1) time (amortized average).

pub fn merge(&mut self, other: Self)

pub fn to_arrow(&self) -> ArrowSchema

pub fn iter_fields( &self ) -> impl Iterator<Item = Field> + ExactSizeIterator + '_

pub fn iter_dtypes( &self ) -> impl Iterator<Item = &DataType> + ExactSizeIterator + '_

pub fn iter_names( &self ) -> impl Iterator<Item = &String> + '_ + ExactSizeIterator

pub fn iter(&self) -> impl Iterator<Item = (&String, &DataType)> + '_

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Default for Schema

fn default() -> Schema

Returns the “default value” for a type.

impl From<&Row<'_>> for Schema

Available on crate feature rows only.

fn from(row: &Row<'_>) -> Self

Converts to this type from the input type.

impl From<&Schema> for DataFrame

fn from(schema: &Schema) -> Self

Converts to this type from the input type.

impl<I, J> From<I> for Schemawhere I: Iterator<Item = J>, J: Into<Field>,

fn from(iter: I) -> Self

Converts to this type from the input type.

impl<J> FromIterator<J> for Schemawhere J: Into<Field>,

fn from_iter<I: IntoIterator<Item = J>>(iter: I) -> Self

Creates a value from an iterator.

impl IndexOfSchema for Schema

fn index_of(&self, name: &str) -> Option<usize>

Available on crate feature private only.

Get the index of column by name.

fn try_index_of(&self, name: &str) -> PolarsResult<usize>

Available on crate feature private only.

impl IntoIterator for Schema

type Item = (String, DataType)

The type of the elements being iterated over.

type IntoIter = <IndexMap<String, DataType, RandomState> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Schema> for Schema

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 Eq for Schema

impl StructuralEq for Schema