Struct polars::export::arrow::array::MutableUtf8Array

pub struct MutableUtf8Array<O> where
    O: Offset,  { /* private fields */ }

The mutable version of Utf8Array. See MutableArray for more details.

Implementations

impl<O> MutableUtf8Array<O> where
    O: Offset, 

pub fn new() -> MutableUtf8Array<O>

Initializes a new empty MutableUtf8Array.

pub fn from_data(
    data_type: DataType,
    offsets: Vec<O, Global>,
    values: Vec<u8, Global>,
    validity: Option<MutableBitmap>
) -> MutableUtf8Array<O>

The canonical method to create a MutableUtf8Array out of low-end APIs.

Panics

This function panics iff:

• The offsets and values are inconsistent
• The values between offsets are not utf8 encoded
• The validity is not None and its length is different from offsets’s length minus one.

pub unsafe fn from_data_unchecked(
    data_type: DataType,
    offsets: Vec<O, Global>,
    values: Vec<u8, Global>,
    validity: Option<MutableBitmap>
) -> MutableUtf8Array<O>

Create a MutableUtf8Array out of low-end APIs.

Safety

The caller must ensure that every value between offsets is a valid utf8.

Panics

This function panics iff:

• The offsets and values are inconsistent
• The validity is not None and its length is different from offsets’s length minus one.

pub fn with_capacity(capacity: usize) -> MutableUtf8Array<O>

Initializes a new MutableUtf8Array with a pre-allocated capacity of slots.

pub fn with_capacities(capacity: usize, values: usize) -> MutableUtf8Array<O>

Initializes a new MutableUtf8Array with a pre-allocated capacity of slots and values.

pub fn reserve(&mut self, additional: usize, additional_values: usize)

Reserves additional elements and additional_values on the values buffer.

pub fn push<T>(&mut self, value: Option<T>) where
    T: AsRef<str>, 

Pushes a new element to the array.

Panic

This operation panics iff the length of all values (in bytes) exceeds O maximum value.

pub fn into_arc(self) -> Arc<dyn Array + 'static>

Converts itself into an Array.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the MutableUtf8Array to fit its current length.

impl<O> MutableUtf8Array<O> where
    O: Offset, 

pub fn values(&self) -> &Vec<u8, Global>

returns its values.

pub fn offsets(&self) -> &Vec<O, Global>

returns its offsets.

impl<O> MutableUtf8Array<O> where
    O: Offset, 

pub fn extend_trusted_len_values<I, P>(&mut self, iterator: I) where
    P: AsRef<str>,
    I: TrustedLen<Item = P>, 

Extends the MutableUtf8Array from an iterator of values of trusted len. This differs from extended_trusted_len which accepts iterator of optional values.

pub fn extend_values<I, P>(&mut self, iterator: I) where
    P: AsRef<str>,
    I: Iterator<Item = P>, 

Extends the MutableUtf8Array from an iterator of values. This differs from extended_trusted_len which accepts iterator of optional values.

pub unsafe fn extend_trusted_len_values_unchecked<I, P>(&mut self, iterator: I) where
    P: AsRef<str>,
    I: Iterator<Item = P>, 

Extends the MutableUtf8Array from an iterator of values of trusted len. This differs from extended_trusted_len_unchecked which accepts iterator of optional values.

Safety

The iterator must be trusted len.

pub fn extend_trusted_len<I, P>(&mut self, iterator: I) where
    P: AsRef<str>,
    I: TrustedLen<Item = Option<P>>, 

Extends the MutableUtf8Array from an iterator of trusted len.

pub unsafe fn extend_trusted_len_unchecked<I, P>(&mut self, iterator: I) where
    P: AsRef<str>,
    I: Iterator<Item = Option<P>>, 

Extends MutableUtf8Array from an iterator of trusted len.

Safety

The iterator must be trusted len.

pub unsafe fn from_trusted_len_iter_unchecked<I, P>(
    iterator: I
) -> MutableUtf8Array<O> where
    P: AsRef<str>,
    I: Iterator<Item = Option<P>>, 

Creates a MutableUtf8Array from an iterator of trusted length.

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

pub fn from_trusted_len_iter<I, P>(iterator: I) -> MutableUtf8Array<O> where
    P: AsRef<str>,
    I: TrustedLen<Item = Option<P>>, 

Creates a MutableUtf8Array from an iterator of trusted length.

pub unsafe fn from_trusted_len_values_iter_unchecked<T, I>(
    iterator: I
) -> MutableUtf8Array<O> where
    T: AsRef<str>,
    I: Iterator<Item = T>, 

Creates a MutableUtf8Array from an iterator of trusted length of &str.

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

pub fn from_trusted_len_values_iter<T, I>(iterator: I) -> MutableUtf8Array<O> where
    T: AsRef<str>,
    I: TrustedLen<Item = T>, 

Creates a new MutableUtf8Array from a TrustedLen of &str.

pub unsafe fn try_from_trusted_len_iter_unchecked<E, I, P>(
    iterator: I
) -> Result<MutableUtf8Array<O>, E> where
    P: AsRef<str>,
    I: IntoIterator<Item = Result<Option<P>, E>>, 

Creates a MutableUtf8Array from an falible iterator of trusted length.

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

pub fn try_from_trusted_len_iter<E, I, P>(
    iterator: I
) -> Result<MutableUtf8Array<O>, E> where
    P: AsRef<str>,
    I: TrustedLen<Item = Result<Option<P>, E>>, 

Creates a MutableUtf8Array from an falible iterator of trusted length.

pub fn from_iter_values<T, I>(iterator: I) -> MutableUtf8Array<O> where
    T: AsRef<str>,
    I: Iterator<Item = T>, 

Creates a new MutableUtf8Array from a Iterator of &str.

Trait Implementations

impl<O> Debug for MutableUtf8Array<O> where
    O: Debug + Offset, 

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

Formats the value using the given formatter.

impl<O> Default for MutableUtf8Array<O> where
    O: Offset, 

fn default() -> MutableUtf8Array<O>

Returns the “default value” for a type.

impl<O, T> Extend<Option<T>> for MutableUtf8Array<O> where
    O: Offset,
    T: AsRef<str>, 

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = Option<T>>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<O> From<MutableUtf8Array<O>> for Utf8Array<O> where
    O: Offset, 

fn from(other: MutableUtf8Array<O>) -> Utf8Array<O>

Performs the conversion.

impl<O, P> FromIterator<Option<P>> for MutableUtf8Array<O> where
    O: Offset,
    P: AsRef<str>, 

fn from_iter<I>(iter: I) -> MutableUtf8Array<O> where
    I: IntoIterator<Item = Option<P>>, 

Creates a value from an iterator.

impl<O> MutableArray for MutableUtf8Array<O> where
    O: Offset, 

fn len(&self) -> usize

The length of the array.

fn validity(&self) -> Option<&MutableBitmap>

The optional validity of the array.

fn as_box(&mut self) -> Box<dyn Array + 'static, Global>

Convert itself to an (immutable) [‘Array’].

fn as_arc(&mut self) -> Arc<dyn Array + 'static>

Convert itself to an (immutable) atomically reference counted Array.

fn data_type(&self) -> &DataType

The DataType of the array.

fn as_any(&self) -> &(dyn Any + 'static)

Convert to Any, to enable dynamic casting.

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

Convert to mutable Any, to enable dynamic casting.

fn push_null(&mut self)

Adds a new null element to the array.

fn shrink_to_fit(&mut self)

Shrink the array to fit its length.

fn is_empty(&self) -> bool

Whether the array is empty.

fn is_valid(&self, index: usize) -> bool

Whether index is valid / set.

impl<O, T> TryExtend<Option<T>> for MutableUtf8Array<O> where
    O: Offset,
    T: AsRef<str>, 

fn try_extend<I>(&mut self, iter: I) -> Result<(), ArrowError> where
    I: IntoIterator<Item = Option<T>>, 

Fallible version of Extend::extend.

impl<O, T> TryPush<Option<T>> for MutableUtf8Array<O> where
    O: Offset,
    T: AsRef<str>, 

fn try_push(&mut self, value: Option<T>) -> Result<(), ArrowError>

Tries to push a new element.