Enum npyz::DType

pub enum DType {
    Plain(TypeStr),
    Array(u64, Box<DType>),
    Record(Vec<Field>),
}

Representation of a Numpy type

Variants

Plain(TypeStr)

Numpy type string. First character is '>' for big endian, '<' for little endian, or can be '|' if it doesn’t matter.

Examples: >i4, <u8, >f8, |S7. The number usually corresponds to the number of bytes (with the single exception of unicode strings |U3).

Array(u64, Box<DType>)

Fixed-size inner array type.

This is only possible inside structured arrays, where fields can themselves be arrays. E.g. in the DType for dtype=[('abc', 'i4', [2, 3])], the DType for abc will be Array(2, Array(3, Plain("<i4"))). In rust, such an array could be read using the following element type:

#[derive(npyz::Serialize, npyz::Deserialize, npyz::AutoSerialize)]
struct Row {
    abc: [[i32; 3]; 2],
}

Record(Vec<Field>)

A structure record array

Implementations

impl DType

pub fn descr(&self) -> String

Numpy format description of record dtype.

Calling descr on DType::Array will not produce a valid python expression (the string will only be suitable for error messages).

pub fn new_scalar(ty: TypeStr) -> Self

Construct a scalar DType. (one which is not a nested array or record type)

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

Get the number of bytes that each item of this type occupies.

If this value overflows the plaform’s usize datatype, returns None.

Trait Implementations

impl Clone for DType

fn clone(&self) -> DType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DType

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

Formats the value using the given formatter.

impl PartialEq for DType

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

impl StructuralEq for DType

impl StructuralPartialEq for DType