Struct Record

pub struct Record(/* private fields */);

A container for storing key-value pairs of various data types.

This structure provides a flexible way to store and retrieve different types of data using string keys. It supports merging records and provides type-safe access to stored values.

Implementations

impl Record

pub fn empty() -> Self

Creates an empty record.

Returns

A new empty record

pub fn from_scalar(name: impl Into<String>, value: f32) -> Self

Creates a record containing a single scalar value.

Arguments

• name - The key for the scalar value
• value - The scalar value to store

Returns

A new record containing the scalar value

pub fn from_slice<K: Into<String> + Clone>(s: &[(K, RecordValue)]) -> Self

Creates a record from a slice of key-value pairs.

Arguments

• s - A slice of tuples containing keys and values

Returns

A new record containing all the key-value pairs

pub fn keys(&self) -> Keys<'_, String, RecordValue>

Returns an iterator over the keys in the record.

Returns

An iterator over the record’s keys

pub fn insert(&mut self, k: impl Into<String>, v: RecordValue)

Inserts a key-value pair into the record.

Arguments

• k - The key to insert
• v - The value to insert

pub fn iter(&self) -> Iter<'_, String, RecordValue>

Returns an iterator over the key-value pairs in the record.

Returns

An iterator over the record’s key-value pairs

pub fn into_iter_in_record(self) -> IntoIter<String, RecordValue>

Returns an iterator that consumes the record.

Returns

An iterator that takes ownership of the record

pub fn get(&self, k: &str) -> Option<&RecordValue>

Gets a reference to the value associated with the given key.

Arguments

• k - The key to look up

Returns

A reference to the value if the key exists, None otherwise

pub fn merge(self, record: Record) -> Self

Merges two records, consuming both.

If both records contain the same key, the value from the second record will overwrite the value from the first record.

Arguments

• record - The record to merge with

Returns

A new record containing all key-value pairs from both records

pub fn merge_inplace(&mut self, record: Record)

Merges another record into this one in place.

If both records contain the same key, the value from the second record will overwrite the value from this record.

Arguments

• record - The record to merge with

pub fn get_scalar(&self, k: &str) -> Result<f32, LrrError>

Gets a scalar value from the record.

Arguments

• k - The key of the scalar value

Returns

The scalar value if it exists and is of the correct type

Errors

Returns an error if:

• The key does not exist
• The value is not a scalar

pub fn get_array1(&self, k: &str) -> Result<Vec<f32>, LrrError>

Gets a 1-dimensional array from the record.

Arguments

• k - The key of the array

Returns

The array if it exists and is of the correct type

Errors

Returns an error if:

• The key does not exist
• The value is not a 1-dimensional array

pub fn get_array2(&self, k: &str) -> Result<(Vec<f32>, [usize; 2]), LrrError>

Gets a 2-dimensional array from the record.

Arguments

• k - The key of the array

Returns

A tuple containing the array data and its shape

Errors

Returns an error if:

• The key does not exist
• The value is not a 2-dimensional array

pub fn get_array3(&self, k: &str) -> Result<(Vec<f32>, [usize; 3]), LrrError>

Gets a 3-dimensional array from the record.

Arguments

• k - The key of the array

Returns

A tuple containing the array data and its shape

Errors

Returns an error if:

• The key does not exist
• The value is not a 3-dimensional array

pub fn get_string(&self, k: &str) -> Result<String, LrrError>

Gets a string value from the record.

Arguments

• k - The key of the string

Returns

The string if it exists and is of the correct type

Errors

Returns an error if:

• The key does not exist
• The value is not a string

pub fn is_empty(&self) -> bool

Checks if the record is empty.

Returns

true if the record contains no key-value pairs

pub fn get_scalar_without_key(&self) -> Option<f32>

Gets a scalar value from the record without specifying a key.

This method is useful when the record contains only one scalar value.

Returns

The scalar value if it exists and is the only value in the record

Trait Implementations

impl Debug for Record

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

Formats the value using the given formatter.