Struct PyFixedUnicode

#[repr(transparent)]
pub struct PyFixedUnicode<const N: usize>(pub [Py_UCS4; N]);

A newtype wrapper around [[PyUCS4; N]][Py_UCS4] to handle str_ scalars while satisfying coherence.

Note that when creating arrays of Unicode strings without an explicit dtype, NumPy will automatically determine the smallest possible array length at runtime.

For example,

numpy.array(["foo🐍", "bar🦀", "foobar"])

yields U6 for array.dtype.

On the Rust side however, the length N of PyFixedUnicode<N> must always be given explicitly and as a compile-time constant. For this work reliably, the Python code should set the dtype explicitly, e.g.

numpy.array(["foo🐍", "bar🦀", "foobar"], dtype='U12')

always matching PyArray1<PyFixedUnicode<12>>.

Example

use numpy::{PyArray1, PyUntypedArrayMethods, PyFixedUnicode};

let array = PyArray1::<PyFixedUnicode<3>>::from_vec(py, vec![[b'b' as _, b'a' as _, b'r' as _].into()]);

assert!(array.dtype().to_string().contains("U3"));

Tuple Fields

0: [Py_UCS4; N]

Trait Implementations

impl<const N: usize> Clone for PyFixedUnicode<N>

fn clone(&self) -> PyFixedUnicode<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for PyFixedUnicode<N>

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

Formats the value using the given formatter.

impl<const N: usize> Display for PyFixedUnicode<N>

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

Formats the value using the given formatter.

impl<const N: usize> Element for PyFixedUnicode<N>

const IS_COPY: bool = true

Flag that indicates whether this type is trivially copyable.

fn get_dtype(py: Python<'_>) -> Bound<'_, PyArrayDescr>

Returns the associated type descriptor (“dtype”) for the given element type.

fn clone_ref(&self, _py: Python<'_>) -> Self

Create a clone of the value while the GIL is guaranteed to be held.

fn vec_from_slice(_py: Python<'_>, slc: &[Self]) -> Vec<Self>

Create an owned copy of the slice while the GIL is guaranteed to be held.

fn array_from_view<D>( _py: Python<'_>, view: ArrayView<'_, Self, D>, ) -> Array<Self, D>

where D: Dimension,

Create an owned copy of the array while the GIL is guaranteed to be held.

impl<const N: usize> From<[u32; N]> for PyFixedUnicode<N>

fn from(val: [Py_UCS4; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> Hash for PyFixedUnicode<N>

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<const N: usize> Ord for PyFixedUnicode<N>

fn cmp(&self, other: &PyFixedUnicode<N>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const N: usize> PartialEq for PyFixedUnicode<N>

fn eq(&self, other: &PyFixedUnicode<N>) -> 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<const N: usize> PartialOrd for PyFixedUnicode<N>

fn partial_cmp(&self, other: &PyFixedUnicode<N>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> Copy for PyFixedUnicode<N>

impl<const N: usize> Eq for PyFixedUnicode<N>

impl<const N: usize> StructuralPartialEq for PyFixedUnicode<N>