text_document_format.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/store/re_sdk_types/definitions/rerun/blueprint/archetypes/text_document_format.fbs".
 
#pragma once
 
#include "../../blueprint/components/enabled.hpp"
#include "../../collection.hpp"
#include "../../component_batch.hpp"
#include "../../component_column.hpp"
#include "../../result.hpp"
 
#include <cstdint>
#include <optional>
#include <utility>
#include <vector>
 
namespace rerun::blueprint::archetypes {
    /// **Archetype**: Formatting options for the text document view.
    ///
    /// These options only apply to plain text documents and have no effect on Markdown documents.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct TextDocumentFormat {
        /// Whether to use a monospace font for the document body.
        ///
        /// Defaults to disabled.
        std::optional<ComponentBatch> monospace;
 
        /// Whether to wrap long lines in the document body.
        ///
        /// Defaults to enabled.
        std::optional<ComponentBatch> word_wrap;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] =
            "rerun.blueprint.archetypes.TextDocumentFormat";
 
        /// `ComponentDescriptor` for the `monospace` field.
        static constexpr auto Descriptor_monospace = ComponentDescriptor(
            ArchetypeName, "TextDocumentFormat:monospace",
            Loggable<rerun::blueprint::components::Enabled>::ComponentType
        );
        /// `ComponentDescriptor` for the `word_wrap` field.
        static constexpr auto Descriptor_word_wrap = ComponentDescriptor(
            ArchetypeName, "TextDocumentFormat:word_wrap",
            Loggable<rerun::blueprint::components::Enabled>::ComponentType
        );
 
      public:
        TextDocumentFormat() = default;
        TextDocumentFormat(TextDocumentFormat&& other) = default;
        TextDocumentFormat(const TextDocumentFormat& other) = default;
        TextDocumentFormat& operator=(const TextDocumentFormat& other) = default;
        TextDocumentFormat& operator=(TextDocumentFormat&& other) = default;
 
        /// Update only some specific fields of a `TextDocumentFormat`.
        static TextDocumentFormat update_fields() {
            return TextDocumentFormat();
        }
 
        /// Clear all the fields of a `TextDocumentFormat`.
        static TextDocumentFormat clear_fields();
 
        /// Whether to use a monospace font for the document body.
        ///
        /// Defaults to disabled.
        TextDocumentFormat with_monospace(const rerun::blueprint::components::Enabled& _monospace
        ) && {
            monospace =
                ComponentBatch::from_loggable(_monospace, Descriptor_monospace).value_or_throw();
            return std::move(*this);
        }
 
        /// Whether to wrap long lines in the document body.
        ///
        /// Defaults to enabled.
        TextDocumentFormat with_word_wrap(const rerun::blueprint::components::Enabled& _word_wrap
        ) && {
            word_wrap =
                ComponentBatch::from_loggable(_word_wrap, Descriptor_word_wrap).value_or_throw();
            return std::move(*this);
        }
 
        /// Partitions the component data into multiple sub-batches.
        ///
        /// Specifically, this transforms the existing `ComponentBatch` data into `ComponentColumn`s
        /// instead, via `ComponentBatch::partitioned`.
        ///
        /// This makes it possible to use `RecordingStream::send_columns` to send columnar data directly into Rerun.
        ///
        /// The specified `lengths` must sum to the total length of the component batch.
        Collection<ComponentColumn> columns(const Collection<uint32_t>& lengths_);
 
        /// Partitions the component data into unit-length sub-batches.
        ///
        /// This is semantically similar to calling `columns` with `std::vector<uint32_t>(n, 1)`,
        /// where `n` is automatically guessed.
        Collection<ComponentColumn> columns();
    };
 
} // namespace rerun::blueprint::archetypes
 
namespace rerun {
    /// \private
    template <typename T>
    struct AsComponents;
 
    /// \private
    template <>
    struct AsComponents<blueprint::archetypes::TextDocumentFormat> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(
            const blueprint::archetypes::TextDocumentFormat& archetype
        );
    };
} // namespace rerun