view.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/element/view-fwd.hpp> // IWYU pragma: export
 
//
 
#include <bsoncxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/types/id-fwd.hpp>
#include <bsoncxx/v1/types/value-fwd.hpp>
#include <bsoncxx/v1/types/view-fwd.hpp>
 
#include <bsoncxx/v1/config/export.hpp>
#include <bsoncxx/v1/detail/macros.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <array>
#include <cstddef>
#include <cstdint>
#include <system_error>
#include <type_traits>
 
namespace bsoncxx {
namespace v1 {
namespace element {

class view {
   private:
    class impl;
 
    alignas(BSONCXX_PRIVATE_MAX_ALIGN_T) std::array<unsigned char, 32> _storage;
 
   public:
    BSONCXX_ABI_EXPORT_CDECL() ~view();
 
    // Handled by the nothrow copy constructor.
    // view(view&& other) noexcept;
 
    // Handled by the nothrow copy assignment operator.
    // view& operator=(view&& other) noexcept;

    BSONCXX_ABI_EXPORT_CDECL() view(view const& other) noexcept;

    BSONCXX_ABI_EXPORT_CDECL(view&) operator=(view const& other) noexcept;

    BSONCXX_ABI_EXPORT_CDECL() view();

    explicit BSONCXX_ABI_EXPORT_CDECL() operator bool() const;

    BSONCXX_ABI_EXPORT_CDECL(std::uint8_t const*) raw() const;

    BSONCXX_ABI_EXPORT_CDECL(std::uint32_t) length() const;

    BSONCXX_ABI_EXPORT_CDECL(std::uint32_t) offset() const;

    BSONCXX_ABI_EXPORT_CDECL(std::uint32_t) keylen() const;

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

    BSONCXX_ABI_EXPORT_CDECL(v1::stdx::string_view) key() const;
 
#pragma push_macro("X")
#undef X
#define X(_name, _value) BSONCXX_ABI_EXPORT_CDECL(v1::types::b_##_name) get_##_name() const;

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

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

    BSONCXX_ABI_EXPORT_CDECL(v1::types::value) type_value() const;

    BSONCXX_ABI_EXPORT_CDECL(v1::element::view) operator[](v1::stdx::string_view key) const;

    BSONCXX_ABI_EXPORT_CDECL(v1::element::view) operator[](std::uint32_t idx) const;

    enum class errc {
        zero,         
        invalid_view, 
        invalid_data, 
    };

    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;
 
   private:
    explicit view(impl i);
};
 
} // namespace element
} // namespace v1
} // namespace bsoncxx
 
template <>
struct std::is_error_code_enum<bsoncxx::v1::element::view::errc> : true_type {};
 
#include <bsoncxx/v1/detail/postlude.hpp>