value.hpp

Go to the documentation of this file.

// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <bsoncxx/v1/types/value-fwd.hpp> // IWYU pragma: export
 
//
 
#include <bsoncxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/array/view-fwd.hpp>
#include <bsoncxx/v1/decimal128-fwd.hpp>
#include <bsoncxx/v1/document/view-fwd.hpp>
#include <bsoncxx/v1/oid-fwd.hpp>
#include <bsoncxx/v1/types/id-fwd.hpp>
 
#include <bsoncxx/v1/config/export.hpp>
#include <bsoncxx/v1/detail/macros.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
#include <bsoncxx/v1/types/view.hpp> // IWYU pragma: export
 
#include <array>
#include <chrono>
#include <cstddef>
#include <cstdint>
#include <string>
#include <system_error>
#include <type_traits>
#include <vector>
 
namespace bsoncxx {
namespace v1 {
namespace types {

class value {
   private:
    class impl;
 
    alignas(BSONCXX_PRIVATE_MAX_ALIGN_T) std::array<unsigned char, 32> _storage;
 
   public:
    BSONCXX_ABI_EXPORT_CDECL() ~value();

    BSONCXX_ABI_EXPORT_CDECL() value(value&& other) noexcept;

    BSONCXX_ABI_EXPORT_CDECL(value&) operator=(value&& other) noexcept;

    BSONCXX_ABI_EXPORT_CDECL() value(value const& other);

    BSONCXX_ABI_EXPORT_CDECL(value&) operator=(value const& other);

    value() : value{v1::types::b_null{}} {}

    explicit BSONCXX_ABI_EXPORT_CDECL() value(v1::types::view const& v);
 
#pragma push_macro("X")
#undef X
#define X(_name, _value) explicit BSONCXX_ABI_EXPORT_CDECL() value(v1::types::b_##_name v);

    BSONCXX_V1_TYPES_XMACRO(X)
#pragma pop_macro("X")

    explicit value(std::nullptr_t) : value{v1::types::b_null{}} {}

    explicit value(v1::stdx::string_view v) : value{v1::types::b_string{v}} {}

    explicit value(std::int32_t v) : value{v1::types::b_int32{v}} {}

    explicit value(std::int64_t v) : value{v1::types::b_int64{v}} {}

    explicit value(double v) : value{v1::types::b_double{v}} {}

    explicit value(bool v) : value{v1::types::b_bool{v}} {}

    explicit value(v1::oid v) : value{v1::types::b_oid{v}} {}

    explicit value(v1::decimal128 v) : value{v1::types::b_decimal128{v}} {}

    explicit value(std::chrono::milliseconds v) : value{v1::types::b_date{v}} {}

    explicit value(v1::document::view v) : value{v1::types::b_document{v}} {}

    explicit value(v1::array::view v) : value{v1::types::b_array{v}} {}

    explicit value(std::vector<std::uint8_t> const& v)
        : value{v.data(), v.size(), v1::types::binary_subtype::k_binary} {}

    explicit value(std::vector<std::uint8_t> const& v, v1::types::binary_subtype subtype)
        : value{v.data(), v.size(), subtype} {}

    explicit value(v1::stdx::string_view c, v1::oid v) : value{v1::types::b_dbpointer{c, v}} {}

    explicit value(v1::stdx::string_view code, v1::document::view scope)
        : value{v1::types::b_codewscope{code, scope}} {}

    explicit value(v1::stdx::string_view regex, v1::stdx::string_view options)
        : value{v1::types::b_regex{regex, options}} {}

    explicit value(char const* v) : value{v1::stdx::string_view{v}} {}

    explicit value(std::string const& v) : value{v1::stdx::string_view{v}} {}

    explicit value(std::uint8_t const* data, std::size_t size)
        : value{data, size, v1::types::binary_subtype::k_binary} {}

    explicit BSONCXX_ABI_EXPORT_CDECL()
    value(std::uint8_t const* data, std::size_t size, v1::types::binary_subtype const sub_type);

    BSONCXX_ABI_EXPORT_CDECL(v1::types::id) type_id() const;

    BSONCXX_ABI_EXPORT_CDECL(v1::types::view) view() const;

    /* explicit(false) */ operator v1::types::view() const {
        return this->view();
    }
 
#pragma push_macro("X")
#undef X
#define X(_name, _value)                       \
    v1::types::b_##_name get_##_name() const { \
        return this->view().get_##_name();     \
    }

    BSONCXX_V1_TYPES_XMACRO(X)
#pragma pop_macro("X")

    friend bool operator==(value const& lhs, value const& rhs) {
        return lhs.view() == rhs.view();
    }

    friend bool operator!=(value const& lhs, value const& rhs) {
        return !(lhs == rhs);
    }

    enum class errc {
        zero,               
        invalid_type,       
        invalid_length_u32, 
    };

    static BSONCXX_ABI_EXPORT_CDECL(std::error_category const&) error_category();

    friend std::error_code make_error_code(errc v) {
        return {static_cast<int>(v), error_category()};
    }
 
    class internal;
};
 
} // namespace types
} // namespace v1
} // namespace bsoncxx
 
template <>
struct std::is_error_code_enum<bsoncxx::v1::types::value::errc> : true_type {};
 
#include <bsoncxx/v1/detail/postlude.hpp>