Struct BinTable 

pub struct BinTable { /* private fields */ }

The decoded contents of a binary table extension.

Implementations

impl BinTable

pub fn push_row( &mut self, values: &[Value], ) -> Result<(), Box<dyn Error + Send + Sync>>

Appends a row, one value per column.

This is how to build a table without going through serde — for a complex column, say, which no Rust type maps onto on its own.

Errors

Returns an error when values is not one per column: a short row would leave the columns after it holding whatever the padding happened to be.

pub fn new(field_definitions: Vec<FieldDefinition>) -> Self

An empty table with the given columns.

pub fn field_definitions(&self) -> &[FieldDefinition]

The columns this table is made of.

pub fn bytes_per_row(&self) -> usize

The width of one row in bytes, as NAXIS1 gives it.

pub fn from_u8( header: &Header, data: Vec<u8>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

Reads a table out of a header and its data section.

pub fn row(&self, row: usize) -> Option<Row<'_>>

The row at row, or None past the end of the table.

pub fn data(&self) -> &[u8]

The whole data section: the rows, and then the heap.

pub fn heap_len(&self) -> usize

The size of the heap, which is what a table’s PCOUNT card records.

pub fn heap(&self) -> &[u8]

The table’s heap: the values that variable length array columns point at.

Empty for a table without such columns, which is most of them.

pub fn rows(&self) -> impl Iterator<Item = Row<'_>> + '_

Every row of the table, in order.

pub fn rows_parallel(&self) -> impl ParallelIterator<Item = Row<'_>> + '_

Available on crate feature rayon only.

Every row of the table, decoded in parallel.

pub fn len(&self) -> usize

The number of rows in this table.

pub fn is_empty(&self) -> bool

Whether the table has no rows at all.

Trait Implementations

impl Clone for BinTable

fn clone(&self) -> BinTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinTable

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

Formats the value using the given formatter.

impl Default for BinTable

fn default() -> BinTable

Returns the “default value” for a type.