Struct rerun::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.

Example

Markdown text document

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_text_document").spawn()?;

    rec.log(
        "text_document",
        &rerun::TextDocument::new("Hello, TextDocument!"),
    )?;

    rec.log(
        "markdown",
        &rerun::TextDocument::from_markdown(
            r#"
[Click here to see the raw text](recording://markdown:Text).

Basic formatting:

| **Feature**       | **Alternative** |
| ----------------- | --------------- |
| Plain             |                 |
| *italics*         | _italics_       |
| **bold**          | __bold__        |
| ~~strikethrough~~ |                 |
| `inline code`     |                 |

----------------------------------

# Support
- [x] [Commonmark](https://commonmark.org/help/) support
- [x] GitHub-style strikethrough, tables, and checkboxes
- Basic syntax highlighting for:
  - [x] C and C++
  - [x] Python
  - [x] Rust
  - [ ] Other languages

# Links
You can link to [an entity](recording://markdown),
a [specific instance of an entity](recording://markdown[#0]),
or a [specific component](recording://markdown:Text).

Of course you can also have [normal https links](https://github.com/rerun-io/rerun), e.g. <https://rerun.io>.

# Image
![A random image](https://picsum.photos/640/480)
"#.trim(),
        )
    )?;

    Ok(())
}

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 = 3usize

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

impl TextDocument

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

Create a new TextDocument.

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

The Media Type of the text.

For instance:

• text/plain
• text/markdown

If omitted, text/plain is assumed.

impl TextDocument

pub fn from_file_path(filepath: impl AsRef<Path>) -> Result<TextDocument, Error>

Creates a new TextDocument from a utf8 file.

The media type will be inferred from the path (extension), or the contents if that fails.

pub fn from_file_contents( contents: Vec<u8>, media_type: Option<impl Into<MediaType>> ) -> Result<TextDocument, Error>

Creates a new TextDocument from the contents of a utf8 file.

If unspecified, the media type will be inferred from the contents.

pub fn from_markdown(markdown: impl Into<Text>) -> TextDocument

Creates a new TextDocument containing Markdown.

Equivalent to TextDocument::new(markdown).with_media_type(MediaType::markdown()).

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 display_name() -> &'static str

Readable name for displaying in ui.

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_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> Result<TextDocument, DeserializationError>

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

fn from_arrow( data: impl IntoIterator<Item = (Field, Box<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 TextDocument

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

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

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 SizeBytes for TextDocument

fn heap_size_bytes(&self) -> u64

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

fn is_pod() -> bool

Is Self just plain old data?

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.

impl ArchetypeReflectionMarker for TextDocument

impl Eq for TextDocument

impl StructuralPartialEq for TextDocument