Struct numpy::PyFixedUnicode
source · #[repr(transparent)]pub struct PyFixedUnicode<const N: usize>(pub [Py_UCS4; N]);
Expand description
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_bound(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§
source§impl<const N: usize> Clone for PyFixedUnicode<N>
impl<const N: usize> Clone for PyFixedUnicode<N>
source§fn clone(&self) -> PyFixedUnicode<N>
fn clone(&self) -> PyFixedUnicode<N>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<const N: usize> Debug for PyFixedUnicode<N>
impl<const N: usize> Debug for PyFixedUnicode<N>
source§impl<const N: usize> Display for PyFixedUnicode<N>
impl<const N: usize> Display for PyFixedUnicode<N>
source§impl<const N: usize> Element for PyFixedUnicode<N>
impl<const N: usize> Element for PyFixedUnicode<N>
source§const IS_COPY: bool = true
const IS_COPY: bool = true
Flag that indicates whether this type is trivially copyable. Read more
source§fn get_dtype_bound(py: Python<'_>) -> Bound<'_, PyArrayDescr>
fn get_dtype_bound(py: Python<'_>) -> Bound<'_, PyArrayDescr>
Returns the associated type descriptor (“dtype”) for the given element type.
source§fn get_dtype<'py>(py: Python<'py>) -> &'py PyArrayDescr
fn get_dtype<'py>(py: Python<'py>) -> &'py PyArrayDescr
👎Deprecated since 0.21.0: This will be replaced by
get_dtype_bound
in the future.Returns the associated type descriptor (“dtype”) for the given element type.
source§impl<const N: usize> Hash for PyFixedUnicode<N>
impl<const N: usize> Hash for PyFixedUnicode<N>
source§impl<const N: usize> Ord for PyFixedUnicode<N>
impl<const N: usize> Ord for PyFixedUnicode<N>
source§fn cmp(&self, other: &PyFixedUnicode<N>) -> Ordering
fn cmp(&self, other: &PyFixedUnicode<N>) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
source§impl<const N: usize> PartialEq for PyFixedUnicode<N>
impl<const N: usize> PartialEq for PyFixedUnicode<N>
source§fn eq(&self, other: &PyFixedUnicode<N>) -> bool
fn eq(&self, other: &PyFixedUnicode<N>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl<const N: usize> PartialOrd for PyFixedUnicode<N>
impl<const N: usize> PartialOrd for PyFixedUnicode<N>
source§fn partial_cmp(&self, other: &PyFixedUnicode<N>) -> Option<Ordering>
fn partial_cmp(&self, other: &PyFixedUnicode<N>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moreimpl<const N: usize> Copy for PyFixedUnicode<N>
impl<const N: usize> Eq for PyFixedUnicode<N>
impl<const N: usize> StructuralPartialEq for PyFixedUnicode<N>
Auto Trait Implementations§
impl<const N: usize> RefUnwindSafe for PyFixedUnicode<N>
impl<const N: usize> Send for PyFixedUnicode<N>
impl<const N: usize> Sync for PyFixedUnicode<N>
impl<const N: usize> Unpin for PyFixedUnicode<N>
impl<const N: usize> UnwindSafe for PyFixedUnicode<N>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.