component_type.hpp

#pragma once
 
#include <memory>
#include <string_view>
 
#include "result.hpp"
 
namespace arrow {
    class DataType;
} // namespace arrow
 
namespace rerun {
    /// Handle to a registered component types.
    using ComponentTypeHandle = uint32_t;
 
    /// A type of component that can be registered.
    ///
    /// All built-in components automatically register their types lazily upon first serialization.
    struct ComponentType {
        std::string_view name;
        const std::shared_ptr<arrow::DataType>& arrow_datatype;
 
        ComponentType(
            std::string_view name_, const std::shared_ptr<arrow::DataType>& arrow_datatype_
        )
            : name(name_), arrow_datatype(arrow_datatype_) {}
 
        /// Registers a component type with the SDK.
        ///
        /// There is currently no deregistration mechanism.
        /// Ideally, this method is only ever called once per component type.
        Result<ComponentTypeHandle> register_component() const;
    };
} // namespace rerun