sort_by.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/build/re_type_definitions/rerun/blueprint/encodings/sort_by.def.rs".
 
#pragma once
 
#include "../../encodings/utf8.hpp"
#include "../../result.hpp"
#include "sort_direction.hpp"
 
#include <cstdint>
#include <memory>
#include <optional>
 
namespace arrow {
    class Array;
    class DataType;
    class StructBuilder;
} // namespace arrow
 
namespace rerun::blueprint::encodings {
    /// **Encoding**: The column and direction a table's rows are sorted by.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct SortBy {
        /// The name of the column the rows are sorted by.
        ///
        /// Same semantics as `components::ColumnName`.
        rerun::encodings::Utf8 column;
 
        /// The direction the rows are sorted in.
        ///
        /// If not set, the viewer sorts ascending.
        std::optional<rerun::blueprint::encodings::SortDirection> direction;
 
      public:
        SortBy() = default;
    };
} // namespace rerun::blueprint::encodings
 
namespace rerun {
    template <typename T>
    struct Loggable;
 
    /// \private
    template <>
    struct Loggable<blueprint::encodings::SortBy> {
        static constexpr std::string_view ComponentType = "rerun.blueprint.encodings.SortBy";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_data_type();
 
        /// Serializes an array of `rerun::blueprint:: encodings::SortBy` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const blueprint::encodings::SortBy* instances, size_t num_instances
        );
 
        /// Fills an arrow array builder with an array of this type.
        static rerun::Error fill_arrow_array_builder(
            arrow::StructBuilder* builder, const blueprint::encodings::SortBy* elements,
            size_t num_elements
        );
    };
} // namespace rerun