element.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/document/element-fwd.hpp> // IWYU pragma: export
 
//
 
#include <bsoncxx/v1/element/view.hpp> // IWYU pragma: export
 
#include <cstddef>
#include <cstdint>
 
#include <bsoncxx/array/element-fwd.hpp>
#include <bsoncxx/document/element-fwd.hpp>
#include <bsoncxx/document/view-fwd.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <bsoncxx/types-fwd.hpp>
#include <bsoncxx/types/bson_value/value-fwd.hpp>
#include <bsoncxx/types/bson_value/view-fwd.hpp>
 
#include <bsoncxx/stdx/optional.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <bsoncxx/stdx/string_view.hpp>
 
#include <bsoncxx/config/prelude.hpp>
 
namespace bsoncxx {
namespace v_noabi {
namespace document {

class element {
   private:
    v1::element::view _view;
 
   public:
    element() = default;

    /* explicit(false) */ element(v1::element::view const& v) : _view{v} {}

    explicit operator v1::element::view() const {
        return _view;
    }

    explicit operator bool() const {
        return _view.operator bool();
    }

    std::uint8_t const* raw() const {
        return _view.raw();
    }

    std::uint32_t length() const {
        return _view.length();
    }

    std::uint32_t offset() const {
        return _view.offset();
    }

    std::uint32_t keylen() const {
        return _view.keylen();
    }

    BSONCXX_ABI_EXPORT_CDECL(v_noabi::type) type() 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(v_noabi::types::b_##_name) get_##_name() const;

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

    BSONCXX_ABI_EXPORT_CDECL(v_noabi::types::bson_value::view) get_value() const;

    BSONCXX_ABI_EXPORT_CDECL(v_noabi::types::bson_value::value) get_owning_value() const;

    BSONCXX_ABI_EXPORT_CDECL(v_noabi::types::bson_value::view) type_view() const;

    BSONCXX_ABI_EXPORT_CDECL(v_noabi::types::bson_value::value) type_value() const;

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

    BSONCXX_ABI_EXPORT_CDECL(v_noabi::array::element) operator[](std::uint32_t i) const;
};


BSONCXX_ABI_EXPORT_CDECL(bool) operator==(element const& lhs, v_noabi::types::bson_value::view const& rhs);

inline bool operator==(v_noabi::types::bson_value::view const& lhs, element const& rhs) {
    return rhs == lhs;
}

inline bool operator!=(element const& lhs, v_noabi::types::bson_value::view const& rhs) {
    return !(lhs == rhs);
}

inline bool operator!=(v_noabi::types::bson_value::view const& lhs, element const& rhs) {
    return !(lhs == rhs);
}

 
} // namespace document
} // namespace v_noabi
} // namespace bsoncxx
 
namespace bsoncxx {
namespace v_noabi {
 
// Ambiguous whether `v1::element::view` should be converted to `v_noabi::array::element` or
// `v_noabi::document::element.` Require users to explicitly cast to the expected type instead.
//
// v_noabi::document::element from_v1(v1::element::view const& v);

inline v1::element::view to_v1(v_noabi::document::element const& v) {
    return v1::element::view{v};
}
 
} // namespace v_noabi
} // namespace bsoncxx
 
namespace bsoncxx {
namespace document {
 
using v_noabi::document::operator==;
using v_noabi::document::operator!=;
 
} // namespace document
} // namespace bsoncxx
 
#include <bsoncxx/config/postlude.hpp>