Struct DataFile

pub struct DataFile<Int> { /* private fields */ }

The top-level structure which represents a data file.

A data file is a key-value store, where the key is a MiniZinc identifier, and the value is one of:

• int
• bool
• array of one of the above

Conceptually, the integers in the MiniZinc specification are unbounded, which means the scalar signed integers not model the DZN integers well. However, from a practical standpoint, many uses of DZN files do only deal with i32 or others. Therefore, DataFile is generic over the integer type to allow the user to decide how big the integers can be.

Implementations

impl<Int: Integer> DataFile<Int>

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

where Value<Int>: GetValue<T>,

Get a value from the data file with the given key.

When attempting to get a specific type, this method does not discriminate to the key not existing at all, or whether the value is a different type. In either situation, None is returned.

pub fn array_1d<T>( &self, key: &str, length: usize, ) -> Option<&ShapedArray<T, 1>>

where ValueArray<Int, 1>: GetValue<ShapedArray<T, 1>>,

Get a 1-dimensional array from the data file with the given key and length.

pub fn array_2d<T>( &self, key: &str, shape: [usize; 2], ) -> Option<&ShapedArray<T, 2>>

where ValueArray<Int, 2>: GetValue<ShapedArray<T, 2>>,

Get a 2-dimensional array from the data file with the given key.

The array shape should match shape.

Trait Implementations

impl<Int: Clone> Clone for DataFile<Int>

fn clone(&self) -> DataFile<Int>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Int: Debug> Debug for DataFile<Int>

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

Formats the value using the given formatter.

impl<Int: Default> Default for DataFile<Int>

fn default() -> DataFile<Int>

Returns the “default value” for a type.