Struct GridRecord 

pub struct GridRecord {
    pub data: IndexMap<String, DmapField>,
}

Struct containing the checked fields of a single GRID record.

Fields

data: IndexMap<String, DmapField>

Trait Implementations

impl Clone for GridRecord

fn clone(&self) -> GridRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GridRecord

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

Formats the value using the given formatter.

impl PartialEq for GridRecord

fn eq(&self, other: &GridRecord) -> 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 Record<'_> for GridRecord

fn inner(self) -> IndexMap<String, DmapField>

Gets the underlying data of self.

fn get(&self, key: &str) -> Option<&DmapField>

Returns the field with name key, if it exists in the record.

fn keys(&self) -> Vec<&String>

Returns the names of all fields stored in the record.

fn new( fields: &mut IndexMap<String, DmapField>, ) -> Result<GridRecord, DmapError>

Creates a new object from the parsed scalars and vectors.

fn to_bytes(&self) -> Result<Vec<u8>, DmapError>

Attempts to copy self to a raw byte representation.

fn is_metadata_field(name: &str) -> bool

Returns whether name is a metadata field of the record.

fn read_first_record(dmap_data: impl Read) -> Result<Self, DmapError>

where Self: Sized + Send,

Reads from dmap_data and parses into Vec<Self>.

fn read_records(dmap_data: impl Read) -> Result<Vec<Self>, DmapError>

where Self: Sized + Send,

Reads from dmap_data and parses into Vec<Self>.

fn read_metadata( dmap_data: impl Read, ) -> Result<Vec<IndexMap<String, DmapField>>, DmapError>

where Self: Sized + Send,

Reads metadata of records from dmap_data and parses into Vec<Self>.

fn read_records_lax( dmap_data: impl Read, ) -> Result<(Vec<Self>, Option<usize>), DmapError>

where Self: Sized + Send,

Reads from dmap_data and parses into Vec<Self>.

fn read_file<P: AsRef<Path>>(infile: P) -> Result<Vec<Self>, DmapError>

where Self: Sized + Send,

Read a DMAP file of type Self

fn read_file_lax<P: AsRef<Path>>( infile: P, ) -> Result<(Vec<Self>, Option<usize>), DmapError>

where Self: Sized + Send,

Read a DMAP file of type Self.

fn sniff_file<P: AsRef<Path>>(infile: P) -> Result<Self, DmapError>

where Self: Sized + Send,

Reads the first record of a DMAP file of type Self.

fn read_file_metadata<P: AsRef<Path>>( infile: P, ) -> Result<Vec<IndexMap<String, DmapField>>, DmapError>

where Self: Sized + Send,

Read the metadata from a DMAP file of type Self

fn parse_metadata( cursor: &mut Cursor<Vec<u8>>, ) -> Result<IndexMap<String, DmapField>, DmapError>

where Self: Sized,

Reads a record from cursor, only keeping the metadata fields.

fn parse_record(cursor: &mut Cursor<Vec<u8>>) -> Result<Self, DmapError>

where Self: Sized,

Reads a record from cursor.

fn check_fields( field_dict: &mut IndexMap<String, DmapField>, fields_for_type: &Fields<'_>, ) -> Result<(), DmapError>

Checks the validity of an IndexMap as a representation of a DMAP record.

fn coerce( fields_dict: &mut IndexMap<String, DmapField>, fields_for_type: &Fields<'_>, ) -> Result<Self, DmapError>

Attempts to massage the entries of an IndexMap into the proper types for a DMAP record.

fn data_to_bytes( data: &IndexMap<String, DmapField>, fields_for_type: &Fields<'_>, ) -> Result<(i32, i32, Vec<u8>), DmapError>

Converts the entries of an IndexMap into a raw byte representation, including metadata about the entries (DMAP key, name\[, dimensions\]).

fn inspect_bytes( &self, fields_for_type: &Fields<'_>, ) -> Result<Vec<(String, usize, Vec<u8>)>, DmapError>

Converts the entries of a Record into a raw byte representation, for debugging the conversion.

fn into_bytes(recs: &Vec<Self>) -> Result<Vec<u8>, DmapError>

Creates the byte represenation of a collection of Records.

fn try_into_bytes( recs: Vec<IndexMap<String, DmapField>>, ) -> Result<Vec<u8>, DmapError>

Attempts to convert recs to Self then convert to bytes.

fn write_to_file<P: AsRef<Path>>( recs: &Vec<Self>, outfile: P, ) -> Result<(), DmapError>

Writes a collection of Records to outfile.

impl TryFrom<&mut IndexMap<String, DmapField>> for GridRecord

type Error = DmapError

The type returned in the event of a conversion error.

fn try_from( value: &mut IndexMap<String, DmapField>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<IndexMap<String, DmapField>> for GridRecord

type Error = DmapError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for GridRecord