re_sorbet/selectors.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
use re_log_types::{EntityPath, Timeline, TimelineName};
use re_types_core::ComponentName;
use crate::{ColumnDescriptor, ComponentColumnDescriptor, IndexColumnDescriptor};
/// Describes a column selection to return as part of a query.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum ColumnSelector {
Time(TimeColumnSelector),
Component(ComponentColumnSelector),
//TODO(jleibs): Add support for archetype-based component selection.
//ArchetypeField(ArchetypeFieldColumnSelector),
}
impl From<ColumnDescriptor> for ColumnSelector {
#[inline]
fn from(desc: ColumnDescriptor) -> Self {
match desc {
ColumnDescriptor::Time(desc) => Self::Time(desc.into()),
ColumnDescriptor::Component(desc) => Self::Component(desc.into()),
}
}
}
impl From<TimeColumnSelector> for ColumnSelector {
#[inline]
fn from(desc: TimeColumnSelector) -> Self {
Self::Time(desc)
}
}
impl From<ComponentColumnSelector> for ColumnSelector {
#[inline]
fn from(desc: ComponentColumnSelector) -> Self {
Self::Component(desc)
}
}
/// Select a time column.
//
// TODO(cmc): This shouldn't be specific to time, this should be an `IndexColumnSelector` or smth.
// Particularly unfortunate that this one already leaks into the public APIā¦
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct TimeColumnSelector {
/// The name of the timeline.
pub timeline: TimelineName,
}
impl From<TimelineName> for TimeColumnSelector {
#[inline]
fn from(timeline: TimelineName) -> Self {
Self { timeline }
}
}
impl From<Timeline> for TimeColumnSelector {
#[inline]
fn from(timeline: Timeline) -> Self {
Self {
timeline: *timeline.name(),
}
}
}
impl From<&str> for TimeColumnSelector {
#[inline]
fn from(timeline: &str) -> Self {
Self {
timeline: timeline.into(),
}
}
}
impl From<String> for TimeColumnSelector {
#[inline]
fn from(timeline: String) -> Self {
Self {
timeline: timeline.into(),
}
}
}
impl From<IndexColumnDescriptor> for TimeColumnSelector {
#[inline]
fn from(desc: IndexColumnDescriptor) -> Self {
Self {
timeline: desc.timeline_name(),
}
}
}
/// Select a component based on its `EntityPath` and `ComponentName`.
///
/// Note, that in the future when Rerun supports duplicate tagged components
/// on the same entity, this selector may be ambiguous. In this case, the
/// query result will return an Error if it cannot determine a single selected
/// component.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ComponentColumnSelector {
/// The path of the entity.
pub entity_path: EntityPath,
/// Semantic name associated with this data.
///
/// This string will be flexibly matched against the available component names.
/// Valid matches are case invariant matches of either the full name or the short name.
pub component_name: String,
}
impl From<ComponentColumnDescriptor> for ComponentColumnSelector {
#[inline]
fn from(desc: ComponentColumnDescriptor) -> Self {
Self {
entity_path: desc.entity_path.clone(),
component_name: desc.component_name.short_name().to_owned(),
}
}
}
impl ComponentColumnSelector {
/// Select a component of a given type, based on its [`EntityPath`]
#[inline]
pub fn new<C: re_types_core::Component>(entity_path: EntityPath) -> Self {
Self {
entity_path,
component_name: C::name().short_name().to_owned(),
}
}
/// Select a component based on its [`EntityPath`] and [`ComponentName`].
#[inline]
pub fn new_for_component_name(entity_path: EntityPath, component_name: ComponentName) -> Self {
Self {
entity_path,
component_name: component_name.short_name().to_owned(),
}
}
}
impl std::fmt::Display for ComponentColumnSelector {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let Self {
entity_path,
component_name,
} = self;
f.write_fmt(format_args!("{entity_path}:{component_name}"))
}
}
// TODO(jleibs): Add support for archetype-based column selection.
/*
/// Select a component based on its `Archetype` and field.
pub struct ArchetypeFieldColumnSelector {
/// The path of the entity.
entity_path: EntityPath,
/// Name of the `Archetype` associated with this data.
archetype: ArchetypeName,
/// The field within the `Archetype` associated with this data.
field: String,
}
*/