re_components 0.9.0-alpha.1

The standard rerun data types, component types, and archetypes
Documentation 
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

use arrow2_convert::{ArrowDeserialize, ArrowField, ArrowSerialize};

/// A text element intended to be displayed in a text-box
///
/// ```
/// use re_components::TextBox;
/// use arrow2_convert::field::ArrowField;
/// use arrow2::datatypes::{DataType, Field};
///
/// assert_eq!(
///     TextBox::data_type(),
///     DataType::Struct(vec![
///         Field::new("body", DataType::Utf8, false),
///     ])
/// );
/// ```
// TODO(jleibs): Should this be reconciled with the `TextEntry` component?
#[derive(Clone, Debug, ArrowField, ArrowSerialize, ArrowDeserialize, PartialEq, Eq)]
pub struct TextBox {
    // TODO(jleibs): Support options for advanced styling. HTML? Markdown?
    pub body: String, // TODO(#1887): avoid allocations
}

impl TextBox {
    #[inline]
    pub fn new(body: impl Into<String>) -> Self {
        Self { body: body.into() }
    }

    #[inline]
    pub fn from_body(body: impl Into<String>) -> Self {
        Self { body: body.into() }
    }
}

impl re_log_types::LegacyComponent for TextBox {
    #[inline]
    fn legacy_name() -> re_log_types::ComponentName {
        "rerun.text_box".into()
    }
}

re_log_types::component_legacy_shim!(TextBox);