Struct DataLoaderSettings 

pub struct DataLoaderSettings {
    pub application_id: Option<ApplicationId>,
    pub recording_id: RecordingId,
    pub opened_store_id: Option<StoreId>,
    pub force_store_info: bool,
    pub entity_path_prefix: Option<EntityPath>,
    pub timepoint: Option<TimePoint>,
}

Recommended settings for the DataLoader.

The loader is free to ignore some or all of these.

External DataLoaders will be passed the following CLI parameters:

• --application-id <application_id>
• --opened-application-id <opened_application_id> (if set)
• --recording-id <store_id>
• --opened-recording-id <opened_store_id> (if set)
• --entity-path-prefix <entity_path_prefix> (if set)
• --static (if timepoint is set to the timeless timepoint)
• --timeless [deprecated] (if timepoint is set to the timeless timepoint)
• --time_sequence <timeline1>=<seq1> <timeline2>=<seq2> ... (if timepoint contains sequence data)
• --time_duration_nanos <timeline1>=<duration1> <timeline2>=<duration2> ... (if timepoint contains duration data) in nanos
• --time_timestamp_nanos <timeline1>=<timestamp1> <timeline2>=<timestamp2> ... (if timepoint contains timestamp data) in nanos since epoch

Fields

application_id: Option<ApplicationId>

The recommended re_log_types::ApplicationId to log the data to, based on the surrounding context.

recording_id: RecordingId

The recommended recording id to log the data to, based on the surrounding context.

Log data to this recording if you want it to appear in a new recording shared by all data-loaders for the current loading session.

opened_store_id: Option<StoreId>

The re_log_types::StoreId that is currently opened in the viewer, if any.

force_store_info: bool

Whether SetStoreInfos should be sent, regardless of the surrounding context.

Only useful when creating a recording just-in-time directly in the viewer (which is what happens when importing things into the welcome screen).

entity_path_prefix: Option<EntityPath>

What should the logged entity paths be prefixed with?

timepoint: Option<TimePoint>

At what time(s) should the data be logged to?

Implementations

impl DataLoaderSettings

pub fn recommended(recording_id: impl Into<RecordingId>) -> Self

pub fn recommended_store_id(&self) -> StoreId

Returns the recommended re_log_types::StoreId to log the data to.

pub fn opened_store_id_or_recommended(&self) -> StoreId

Returns the currently opened re_log_types::StoreId if any. Otherwise, returns the recommended store id.

pub fn to_cli_args(&self) -> Vec<String>

Generates CLI flags from these settings, for external data loaders.

Trait Implementations

impl Clone for DataLoaderSettings

fn clone(&self) -> DataLoaderSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataLoaderSettings

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

Formats the value using the given formatter.