Struct specifications::data::RuntimeDataIndex

pub struct RuntimeDataIndex { /* private fields */ }

Defines a structure similar to the data index, except that it is used at runtime when locations have been resolved.

Implementations

impl RuntimeDataIndex

pub fn new() -> Self

Constructor for the RuntimeDataIndex that initializes it to empty. It is up to the planner to populate it.

Returns

A new RuntimeDataIndex instance.

pub fn add_local( &mut self, name: impl Into<String>, access: AccessKind, ) -> Result<(), RuntimeDataIndexError>

Adds a new dataset as a local dataset.

Arguments

• name: The name/identifier of the dataset to add.
• access: The method of accessing this dataset. It should be available immediately by the tasks after this is passed.

Errors

This function may error if this dataset causes a naming conflict.

pub fn add_remote( &mut self, name: impl Into<String>, transfer: PreprocessKind, ) -> Result<(), RuntimeDataIndexError>

Adds a new dataset as a remote dataset.

Arguments

• name: The name/identifier of the dataset to add.
• transfer: The method of transferring this dataset.

Errors

This function may error if this dataset causes a naming conflict.

pub fn is_local(&self, name: impl AsRef<str>) -> Option<bool>

Returns whether the given dataset is locally accessible or not.

Arguments

• name: The name/identifier of the dataset to check.

Returns

true if is locally available, false if it is not, and None if we don’t even know where to get it.

pub fn is_remote(&self, name: impl AsRef<str>) -> Option<bool>

Returns whether the given dataset is remotely accessible only or not.

Arguments

• name: The name/identifier of the dataset to check.

Returns

true if is remotely available, false if it is locally available, and None if we don’t even know where to get it.

pub fn local(&self, name: impl AsRef<str>) -> Option<&AccessKind>

Returns the method of accessing the given dataset if it is local.

Arguments

• name: The name/identifier of the dataset to query for.

Returns

A reference to this dataset’s AccessKind that describes how to access it. If, however, the dataset isn’t locally available, it returns None.

pub fn remote(&self, name: impl AsRef<str>) -> Option<&PreprocessKind>

Returns the method of transferring the given dataset to the local machine if it is remotely available.

Arguments

• name: The name/identifier of the dataset to query for.

Returns

A reference to this dataset’s TransferKind that describes how to transfer it. If, however, the dataset isn’t remotely available, it returns None.

Trait Implementations

impl Clone for RuntimeDataIndex

fn clone(&self) -> RuntimeDataIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeDataIndex

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

Formats the value using the given formatter.

impl Default for RuntimeDataIndex

fn default() -> Self

Returns the “default value” for a type.