Struct re_types::blueprint::archetypes::DataframeQuery

pub struct DataframeQuery {
    pub timeline: Option<SerializedComponentBatch>,
    pub filter_by_range: Option<SerializedComponentBatch>,
    pub filter_is_not_null: Option<SerializedComponentBatch>,
    pub apply_latest_at: Option<SerializedComponentBatch>,
    pub select: Option<SerializedComponentBatch>,
}

Archetype: The query for the dataframe view.

Fields

timeline: Option<SerializedComponentBatch>

The timeline for this query.

If unset, the timeline currently active on the time panel is used.

filter_by_range: Option<SerializedComponentBatch>

If provided, only rows whose timestamp is within this range will be shown.

Note: will be unset as soon as timeline is changed.

filter_is_not_null: Option<SerializedComponentBatch>

If provided, only show rows which contains a logged event for the specified component.

apply_latest_at: Option<SerializedComponentBatch>

Should empty cells be filled with latest-at queries?

select: Option<SerializedComponentBatch>

Selected columns. If unset, all columns are selected.

Implementations

impl DataframeQuery

pub fn descriptor_timeline() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::timeline.

pub fn descriptor_filter_by_range() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::filter_by_range.

pub fn descriptor_filter_is_not_null() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::filter_is_not_null.

pub fn descriptor_apply_latest_at() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::apply_latest_at.

pub fn descriptor_select() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::select.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl DataframeQuery

pub const NUM_COMPONENTS: usize = 6usize

The total number of components in the archetype: 0 required, 1 recommended, 5 optional

impl DataframeQuery

pub fn new() -> Self

Create a new DataframeQuery.

pub fn update_fields() -> Self

Update only some specific fields of a DataframeQuery.

pub fn clear_fields() -> Self

Clear all the fields of a DataframeQuery.

pub fn with_timeline(self, timeline: impl Into<TimelineName>) -> Self

The timeline for this query.

If unset, the timeline currently active on the time panel is used.

pub fn with_filter_by_range( self, filter_by_range: impl Into<FilterByRange>, ) -> Self

If provided, only rows whose timestamp is within this range will be shown.

Note: will be unset as soon as timeline is changed.

pub fn with_filter_is_not_null( self, filter_is_not_null: impl Into<FilterIsNotNull>, ) -> Self

If provided, only show rows which contains a logged event for the specified component.

pub fn with_apply_latest_at( self, apply_latest_at: impl Into<ApplyLatestAt>, ) -> Self

Should empty cells be filled with latest-at queries?

pub fn with_select(self, select: impl Into<SelectedColumns>) -> Self

Selected columns. If unset, all columns are selected.

Trait Implementations

impl Archetype for DataframeQuery

type Indicator = GenericIndicatorComponent<DataframeQuery>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in UI.

fn indicator() -> SerializedComponentBatch

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>, ) -> DeserializationResult<Self>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>, ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for DataframeQuery

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

Exposes the object’s contents as a set of SerializedComponentBatches.

fn to_arrow(&self) -> Result<Vec<(Field, Arc<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Borrow<DataframeQuery> for DataframeView

fn borrow(&self) -> &DataframeQuery

Immutably borrows from an owned value.

impl Clone for DataframeQuery

fn clone(&self) -> DataframeQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataframeQuery

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

Formats the value using the given formatter.

impl Default for DataframeQuery

fn default() -> DataframeQuery

Returns the “default value” for a type.

impl SizeBytes for DataframeQuery

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

impl ArchetypeReflectionMarker for DataframeQuery