Struct RecordArray

pub struct RecordArray {
    pub records: Vec<Record>,
    pub field_names: Vec<String>,
    pub field_titles: HashMap<String, String>,
    /* private fields */
}

A structured array with named fields

Fields

records: Vec<Record>

The array of records

field_names: Vec<String>

The names of the fields (columns)

field_titles: HashMap<String, String>

Optional titles (aliases) for fields

Implementations

impl RecordArray

pub fn new(records: Vec<Record>) -> Result<Self, ArrayError>

Create a new RecordArray from a vector of records

Errors

Returns ArrayError::ValueError if records are empty or have inconsistent field structures.

pub fn with_titles( records: Vec<Record>, titles: HashMap<String, String>, ) -> Result<Self, ArrayError>

Create a new RecordArray with custom field titles

Errors

Returns ArrayError::ValueError if records are invalid or titles reference non-existent fields.

pub const fn set_allow_field_attributes(&mut self, allow: bool)

Enable or disable attribute-style field access

pub const fn allow_field_attributes(&self) -> bool

Get whether attribute-style field access is allowed

pub fn shape(&self) -> &[usize]

Get the shape of the array

pub fn num_records(&self) -> usize

Get the number of records

pub fn get_record(&self, index: usize) -> Option<&Record>

Get a reference to a record by index

pub fn get_record_mut(&mut self, index: usize) -> Option<&mut Record>

Get a mutable reference to a record by index

pub fn get_field_values( &self, field_name: &str, ) -> Result<Vec<FieldValue>, ArrayError>

Get a field values as a vector

Errors

Returns ArrayError::ValueError if the field name is not found.

Panics

Panics if a record doesn’t have the field that should exist based on validation.

pub fn get_field_as_f64( &self, field_name: &str, ) -> Result<Array<f64, Ix1>, ArrayError>

Get a field as an array of f64 values

Errors

Returns ArrayError::ValueError if the field name is not found.

pub fn get_field_as_i64( &self, field_name: &str, ) -> Result<Array<i64, Ix1>, ArrayError>

Get a field as an array of i64 values

Errors

Returns ArrayError::ValueError if the field name is not found or contains non-convertible types.

pub fn get_field_as_string( &self, field_name: &str, ) -> Result<Vec<String>, ArrayError>

Get a field as an array of String values

Errors

Returns ArrayError::ValueError if the field name is not found.

pub fn get_field_by_title( &self, title: &str, ) -> Result<Vec<FieldValue>, ArrayError>

Get a field by its title (alias) rather than its name

Errors

Returns ArrayError::ValueError if the title is not found.

pub fn set_field_value( &mut self, record_idx: usize, field_name: &str, value: FieldValue, ) -> Result<(), ArrayError>

Set a field value for a record

Errors

Returns ArrayError::ValueError if the field name is not found or record index is out of bounds.

pub fn add_field( &mut self, field_name: &str, values: Vec<FieldValue>, ) -> Result<(), ArrayError>

Adds a new field to all records

Errors

Returns ArrayError::ValueError if the field already exists or the number of values doesn’t match the number of records.

pub fn remove_field(&mut self, field_name: &str) -> Result<(), ArrayError>

Removes a field from all records

Errors

Returns ArrayError::ValueError if the field name is not found.

pub fn rename_field( &mut self, old_name: &str, new_name: &str, ) -> Result<(), ArrayError>

Rename a field

Errors

Returns ArrayError::ValueError if old field is not found or new field already exists.

pub fn view(&self, indices: &[usize]) -> Result<Self, ArrayError>

Create a view of the record array with a subset of records

Errors

Returns ArrayError::ValueError if any index is out of bounds.

pub fn filter<F>( &self, field_name: &str, condition: F, ) -> Result<Self, ArrayError>

where F: Fn(&FieldValue) -> bool,

Filter the record array by a condition on a field

Errors

Returns ArrayError::ValueError if the field name is not found.

pub fn merge(&self, other: &Self) -> Result<Self, ArrayError>

Merge two record arrays with compatible fields

Errors

Returns ArrayError::ValueError if the arrays have incompatible field structures.

Trait Implementations

impl Clone for RecordArray

fn clone(&self) -> RecordArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordArray

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

Formats the value using the given formatter.

impl Display for RecordArray

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

Formats the value using the given formatter.