media_type.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/components/media_type.def.rs".
 
#pragma once
 
#include "../encodings/utf8.hpp"
#include "../result.hpp"
 
#include <cstdint>
#include <filesystem>
#include <memory>
#include <string>
#include <utility>
 
namespace rerun::components {
    /// **Component**: A standardized media type (RFC2046, formerly known as MIME types), encoded as a string.
    ///
    /// The complete reference of officially registered media types is maintained by the IANA and can be
    /// consulted at <https://www.iana.org/assignments/media-types/media-types.xhtml>.
    struct MediaType {
        rerun::encodings::Utf8 value;
 
      public: // START of extensions from media_type_ext.cpp:
        /// Construct media type from a null-terminated UTF8 string.
        MediaType(const char* media_type) : value(media_type) {}
 
        // TODO(#2388): come up with some DSL in our flatbuffers definitions so that we can
        // declare these constants directly in there.
 
        /// `text/plain`
        static MediaType plain_text() {
            return "text/plain";
        }
 
        /// `text/markdown`
        ///
        /// <https://www.iana.org/assignments/media-types/text/markdown>
        static MediaType markdown() {
            return "text/markdown";
        }
 
        // ------------------------------------------------
        // Images:
 
        /// [JPEG image](https://en.wikipedia.org/wiki/JPEG): `image/jpeg`.
        static MediaType jpeg() {
            return "image/jpeg";
        }
 
        /// [PNG image](https://en.wikipedia.org/wiki/PNG): `image/png`.
        ///
        /// <https://www.iana.org/assignments/media-types/image/png>
        static MediaType png() {
            return "image/png";
        }
 
        // ------------------------------------------------
        // Meshes:
 
        /// [`glTF`](https://en.wikipedia.org/wiki/GlTF): `model/gltf+json`.
        ///
        /// <https://www.iana.org/assignments/media-types/model/gltf+json>
        static MediaType gltf() {
            return "model/gltf+json";
        }
 
        /// [Binary `glTF`](https://en.wikipedia.org/wiki/GlTF): `model/gltf-binary`.
        ///
        /// <https://www.iana.org/assignments/media-types/model/gltf-binary>
        static MediaType glb() {
            return "model/gltf-binary";
        }
 
        /// [Wavefront `obj`](https://en.wikipedia.org/wiki/Wavefront_.obj_file): `model/obj`.
        ///
        /// <https://www.iana.org/assignments/media-types/model/obj>
        static MediaType obj() {
            return "model/obj";
        }
 
        /// [PLY (Polygon File Format)](https://en.wikipedia.org/wiki/PLY_(file_format)): `application/x-ply`.
        ///
        /// Holds either a mesh or a point cloud, depending on its header.
        static MediaType ply() {
            return "application/x-ply";
        }
 
        /// [Stereolithography Model `stl`](https://en.wikipedia.org/wiki/STL_(file_format)): `model/stl`.
        ///
        /// Either binary or ASCII.
        /// <https://www.iana.org/assignments/media-types/model/stl>
        static MediaType stl() {
            return "model/stl";
        }
 
        // -------------------------------------------------------
        // Compressed Depth Data:
 
        /// RVL compressed depth: `application/rvl`.
        ///
        /// Run length encoding and Variable Length encoding schemes (RVL) compressed depth data format.
        /// <https://www.microsoft.com/en-us/research/wp-content/uploads/2018/09/p100-wilson.pdf>
        static MediaType rvl() {
            return "application/rvl";
        }
 
        // -------------------------------------------------------
        /// Videos:
 
        /// [MP4 video](https://en.wikipedia.org/wiki/MP4_file_format): `video/mp4`.
        ///
        /// <https://www.iana.org/assignments/media-types/video/mp4>
        static MediaType mp4() {
            return "video/mp4";
        }
 
        // -------------------------------------------------------
        // Audio:
 
        /// [AAC audio](https://en.wikipedia.org/wiki/Advanced_Audio_Coding) in a raw ADTS stream: `audio/aac`.
        ///
        /// <https://www.iana.org/assignments/media-types/audio/aac>
        static MediaType aac() {
            return "audio/aac";
        }
 
        /// [FLAC audio](https://en.wikipedia.org/wiki/FLAC): `audio/flac`.
        static MediaType flac() {
            return "audio/flac";
        }
 
        /// [M4A audio](https://en.wikipedia.org/wiki/MP4_file_format) (AAC in an MP4 container): `audio/mp4`.
        ///
        /// <https://www.iana.org/assignments/media-types/audio/mp4>
        static MediaType m4a() {
            return "audio/mp4";
        }
 
        /// [MP3 audio](https://en.wikipedia.org/wiki/MP3): `audio/mpeg`.
        ///
        /// <https://www.iana.org/assignments/media-types/audio/mpeg>
        static MediaType mp3() {
            return "audio/mpeg";
        }
 
        /// [Ogg audio](https://en.wikipedia.org/wiki/Ogg) (Vorbis or Opus): `audio/ogg`.
        ///
        /// <https://www.iana.org/assignments/media-types/audio/ogg>
        static MediaType ogg() {
            return "audio/ogg";
        }
 
        /// [WAV audio](https://en.wikipedia.org/wiki/WAV): `audio/wav`.
        static MediaType wav() {
            return "audio/wav";
        }
 
        static std::optional<MediaType> guess_from_path(const std::filesystem::path& path);
 
        // END of extensions from media_type_ext.cpp, start of generated code:
 
      public:
        MediaType() = default;
 
        MediaType(rerun::encodings::Utf8 value_) : value(std::move(value_)) {}
 
        MediaType& operator=(rerun::encodings::Utf8 value_) {
            value = std::move(value_);
            return *this;
        }
 
        MediaType(std::string value_) : value(std::move(value_)) {}
 
        MediaType& operator=(std::string value_) {
            value = std::move(value_);
            return *this;
        }
 
        /// Cast to the underlying Utf8 encoding
        operator rerun::encodings::Utf8() const {
            return value;
        }
    };
} // namespace rerun::components
 
namespace rerun {
    static_assert(sizeof(rerun::encodings::Utf8) == sizeof(components::MediaType));
 
    /// \private
    template <>
    struct Loggable<components::MediaType> {
        static constexpr std::string_view ComponentType = "rerun.components.MediaType";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_data_type() {
            return Loggable<rerun::encodings::Utf8>::arrow_data_type();
        }
 
        /// Serializes an array of `rerun::components::MediaType` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const components::MediaType* instances, size_t num_instances
        ) {
            if (num_instances == 0) {
                return Loggable<rerun::encodings::Utf8>::to_arrow(nullptr, 0);
            } else if (instances == nullptr) {
                return rerun::Error(
                    ErrorCode::UnexpectedNullArgument,
                    "Passed array instances is null when num_elements> 0."
                );
            } else {
                return Loggable<rerun::encodings::Utf8>::to_arrow(&instances->value, num_instances);
            }
        }
    };
} // namespace rerun