Struct specifications::data::DataIndex

pub struct DataIndex { /* private fields */ }

Defines an index of all datasets known to the instance.

Implementations

impl DataIndex

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, DataIndexError>

Constructor for the DataIndex that reads it from the given path.

Generic arguments

• P: The &Path-like type of the path.

Arguments

• path: The path from which we will read the DataIndex.

Returns

A new DataIndex instance with the datasets stored in the file.

Errors

This function errors if we could not read or parse the file.

pub fn from_reader<R: Read>(reader: R) -> Result<Self, DataIndexError>

Constructor for the DataIndex that reads it from the given reader.

Generic arguments

• R: The Read-enabled type of the reader.

Arguments

• reader: The reader from which we will read the DataIndex.

Returns

A new DataIndex instance with the datasets stored in the reader.

Errors

This function errors if we could not read or parse the reader.

pub fn from_infos(infos: Vec<DataInfo>) -> Result<Self, DataIndexError>

Constructor for the DataIndex that creates it from a list of DataInfos.

Arguments

• infos: The DataInfos on which to base this index.

Returns

A new DataIndex instance with the datasets stored in each of the given infos.

Errors

This function errors if there were namespace conflicts and such.

pub fn get<S: AsRef<str>>(&self, name: S) -> Option<&DataInfo>

Returns a DataInfo that describes all locations that advertise the given dataset and how to access it per-location.

Generic arguments

• S: The String-like type of the name.

Arguments

• name: The dataset identifier to search for.

Returns

A DataInfo struct that represents this data asset.

pub fn iter(&self) -> impl Iterator<Item = &DataInfo>

Returns an iterator over the internal DataIndices.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut DataInfo>

Returns a(n) (mutable) iterator over the internal DataIndices.

Trait Implementations

impl Clone for DataIndex

fn clone(&self) -> DataIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DataIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> IntoIterator for &'a DataIndex

type IntoIter = Values<'a, String, DataInfo>

Which kind of iterator are we turning this into?

type Item = &'a DataInfo

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut DataIndex

type IntoIter = ValuesMut<'a, String, DataInfo>

Which kind of iterator are we turning this into?

type Item = &'a mut DataInfo

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for DataIndex

type IntoIter = IntoValues<String, DataInfo>

Which kind of iterator are we turning this into?

type Item = DataInfo

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for DataIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.