Struct re_sdk::TextDocument

pub struct TextDocument {
    pub text: Text,
    pub media_type: Option<MediaType>,
}

Archetype: A text element intended to be displayed in its own text-box.

Supports raw text and markdown.

Fields

text: Text

Contents of the text document.

media_type: Option<MediaType>

The Media Type of the text.

For instance:

• text/plain
• text/markdown

If omitted, text/plain is assumed.

Implementations

impl TextDocument

pub const NUM_COMPONENTS: usize = 4usize

impl TextDocument

pub fn new(text: impl Into<Text>) -> TextDocument

pub fn with_media_type(self, media_type: impl Into<MediaType>) -> TextDocument

Trait Implementations

impl Archetype for TextDocument

type Indicator = GenericIndicatorComponent<TextDocument>

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 indicator() -> MaybeOwnedComponentBatch<'static>

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

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

Returns the names of all components that must be provided by the user when constructing this archetype.

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

Returns the names of all components that should be provided by the user when constructing this archetype.

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

Returns the names of all components that may be provided by the user when constructing this archetype.

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

Returns the names of all components that must, should and may be provided by the user when constructing this archetype.

fn from_arrow( arrow_data: impl IntoIterator<Item = (Field, Box<dyn Array>)> ) -> Result<TextDocument, DeserializationError>

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

impl AsComponents for TextDocument

fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>

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

fn num_instances(&self) -> usize

The number of instances in each batch.

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

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

impl Clone for TextDocument

fn clone(&self) -> TextDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextDocument

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

Formats the value using the given formatter.

impl PartialEq for TextDocument

fn eq(&self, other: &TextDocument) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TextDocument

impl StructuralEq for TextDocument

impl StructuralPartialEq for TextDocument