Struct Datatype 

pub struct Datatype {
    pub scalar: ScalarType,
    pub size: u64,
    pub byteorder: ByteOrder,
    pub shape: Vec<u64>,
    pub fields: Vec<Field>,
}

A complete datatype.

Fields

scalar: ScalarType

The scalar type, or ScalarType::Structured for a compound type.

size: u64

Element size in bytes. Computed for numeric types; carried explicitly for strings, where it is the length in characters times the character width.

byteorder: ByteOrder

Byte order for this type’s elements, where it differs from the array’s.

shape: Vec<u64>

Sub-array shape, for a field that is itself an array.

fields: Vec<Field>

Fields, for a compound type.

Implementations

impl Datatype

pub fn scalar(scalar: ScalarType) -> Datatype

A plain scalar datatype.

pub fn string(scalar: ScalarType, length: u64) -> Datatype

A fixed-length string datatype, sized in characters.

pub fn is_structured(&self) -> bool

Whether this is a compound type.

pub fn item_size(&self) -> u64

The size of one element in bytes.

For a compound type this is the sum of its fields; for a field with a sub-array shape, the element size times the number of elements. Saturating, because every input is a number out of the tree: a compound type’s field list and a field’s own sub-array shape are both attacker-controlled, and a wrapped item size is one a later bounds check agrees with. There is no error channel here, so u64::MAX is the honest answer for “does not fit” – no real element is that wide, and every caller sizing a read against it then refuses.

pub fn parse(doc: &Document, id: NodeId) -> Result<Datatype, Error>

Parse a datatype from a tree node.

Accepts all three shapes the schema allows: a name, a [kind, length] string pair, and a sequence of fields.

Trait Implementations

impl Clone for Datatype

fn clone(&self) -> Datatype

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Datatype

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

Formats the value using the given formatter.

impl Default for Datatype

fn default() -> Datatype

Returns the “default value” for a type.

impl PartialEq for Datatype

fn eq(&self, other: &Datatype) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Datatype