Enum TableColumnFormat 

pub enum TableColumnFormat {
    String(usize),
    StringArray(usize, usize),
    Boolean(usize),
    Bit(usize),
    U8(usize),
    I8(usize),
    U16(usize),
    I16(usize),
    U32(usize),
    I32(usize),
    I64(usize),
    F32(usize),
    F64(usize),
    C32(usize),
    M64(usize),
    VariableLengthArray {
        element: TableElementFormat,
        descriptor: ArrayDescriptor,
        max: usize,
    },
}

The type and repeat count of one binary table column, from its TFORMn card.

The contained count is the TFORMn repeat count r, not a byte length; use TableColumnFormat::bytes_len for the width of the field in the row.

Variants

String(usize)

rA: one string of r characters.

StringArray(usize, usize)

rAw: r characters holding r / w substrings of w characters.

Boolean(usize)

rL: r logical values, one byte each.

Bit(usize)

rX: r bits, packed into ceil(r / 8) bytes.

U8(usize)

rB: r unsigned bytes.

I8(usize)

rS: r signed bytes.

U16(usize)

rU: r unsigned 16-bit integers.

I16(usize)

rI: r signed 16-bit integers.

U32(usize)

rV: r unsigned 32-bit integers.

I32(usize)

rJ: r signed 32-bit integers.

I64(usize)

rK: r signed 64-bit integers.

F32(usize)

rE: r single precision floats.

F64(usize)

rD: r double precision floats.

C32(usize)

rC: r single precision complex values, two f32 each.

M64(usize)

rM: r double precision complex values, two f64 each.

VariableLengthArray

rPt(max) or rQt(max): a variable length array.

The row itself holds only a descriptor saying how many values there are and where in the table’s heap they start; the values live in the heap, after the last row.

Fields

element: TableElementFormat

The type of the values in the heap.

descriptor: ArrayDescriptor

Which descriptor the row carries: P for 32-bit, Q for 64-bit.

max: usize

The (max) hint on the format, or 0 when it carries none. This is the longest array the column promises, not the length of any particular row’s array.

Implementations

impl TableColumnFormat

pub fn parse_into_value(&self, data: &[u8], heap: &[u8]) -> Result<Value>

Decodes this column out of the front of data, which must be the remainder of the row starting at this column’s offset.

heap is the table’s heap, which only a variable length array column reads from; pass an empty slice for a table that has none.

pub fn bytes_len(&self) -> usize

Width of this column in the row, in bytes.

Every column’s offset is the sum of the widths before it, so a wrong answer here misaligns every following column.

pub fn len(&self) -> usize

Number of elements this column holds.

pub fn is_empty(&self) -> bool

Whether this column holds no elements at all.

Trait Implementations

impl Clone for TableColumnFormat

fn clone(&self) -> TableColumnFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TableColumnFormat

impl Debug for TableColumnFormat

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

Formats the value using the given formatter.

impl From<TableColumnFormat> for String

fn from(value: TableColumnFormat) -> String

Converts to this type from the input type.

impl PartialEq for TableColumnFormat

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TableColumnFormat

impl TryFrom<String> for TableColumnFormat

type Error = Box<dyn Error + Send + Sync>

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.