Struct TypeStr 

pub struct TypeStr { /* private fields */ }

Represents an Array Interface type-string.

This is more or less the DType of a scalar type. Exposes a FromStr impl for construction, and a Display impl for writing.

use npyz::TypeStr;

let ts = "|i1".parse::<TypeStr>()?;

assert_eq!(format!("{}", ts), "|i1");
assert_eq!(ts.endianness(), npyz::Endianness::Irrelevant);
assert_eq!(ts.type_char(), npyz::TypeChar::Int);
assert_eq!(ts.size_field(), 1);

Implementations

impl TypeStr

pub fn endianness(&self) -> Endianness

Extract the endianness character from the type string.

pub fn type_char(&self) -> TypeChar

Extract the type character from the type string.

pub fn size_field(&self) -> u64

Extract the “size” field from the type string. This is the number that appears after the type character.

• For most types, this is the number of bytes that a single value occupies.
• For the 'U' type, it is the number of code units.
• For the 'O' type, this returns zero. (the actual string does not contain a number here)

pub fn time_units(&self) -> Option<TimeUnits>

Extract the time units, if this type string has any. Only 'm' and 'M' have time units.

pub fn num_bytes(&self) -> Option<usize>

Get the number of bytes for a single value.

If this size is not fixed (e.g. |O) or would overflow the platform’s usize type, returns None. You can differentiate between these two error cases by calling [Self::has_variable_size].

pub fn uses_pickled_array(&self) -> bool

Returns true if an array using this DType is stored using pickle.

Pickled arrays present unique challenges, and most of the npyz crate does not support them.

Trait Implementations

impl Clone for TypeStr

fn clone(&self) -> TypeStr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeStr

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

Formats the value using the given formatter.

impl Display for TypeStr

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

Formats the value using the given formatter.

impl FromStr for TypeStr

type Err = ParseTypeStrError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, ParseTypeStrError>

Parses a string s to return a value of this type.

impl Hash for TypeStr

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 PartialEq for TypeStr

fn eq(&self, other: &TypeStr) -> 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 Eq for TypeStr

impl StructuralPartialEq for TypeStr