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 <cstddef>
#include <cstdint>
 
#include <bsoncxx/array/element-fwd.hpp>
#include <bsoncxx/document/element-fwd.hpp>
#include <bsoncxx/document/view-fwd.hpp>
#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>
#include <bsoncxx/stdx/string_view.hpp>
 
#include <bsoncxx/config/prelude.hpp>
 
namespace bsoncxx {
namespace v_noabi {
namespace document {
 
class element {
   public:
    BSONCXX_ABI_EXPORT_CDECL() element();
 
    explicit BSONCXX_ABI_EXPORT_CDECL() operator bool() const;
 
    BSONCXX_ABI_EXPORT_CDECL(const std::uint8_t*) raw() const;
 
    BSONCXX_ABI_EXPORT_CDECL(std::uint32_t) length() const;
 
    BSONCXX_ABI_EXPORT_CDECL(std::uint32_t) offset() const;
 
    BSONCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::type) type() const;
 
    BSONCXX_ABI_EXPORT_CDECL(stdx::string_view) key() const;
 
    BSONCXX_ABI_EXPORT_CDECL(std::uint32_t) keylen() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_double) get_double() const;
 
    BSONCXX_DEPRECATED BSONCXX_ABI_EXPORT_CDECL(types::b_string) get_utf8() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_string) get_string() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_document) get_document() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_array) get_array() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_binary) get_binary() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_undefined) get_undefined() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_oid) get_oid() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_bool) get_bool() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_date) get_date() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_null) get_null() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_regex) get_regex() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_dbpointer) get_dbpointer() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_code) get_code() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_symbol) get_symbol() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_codewscope) get_codewscope() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_int32) get_int32() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_timestamp) get_timestamp() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_int64) get_int64() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_decimal128) get_decimal128() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_minkey) get_minkey() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::b_maxkey) get_maxkey() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::bson_value::view) get_value() const;
 
    BSONCXX_ABI_EXPORT_CDECL(types::bson_value::value) get_owning_value() const;
 
    BSONCXX_ABI_EXPORT_CDECL(element) operator[](stdx::string_view key) const;
 
    BSONCXX_ABI_EXPORT_CDECL(array::element) operator[](std::uint32_t i) const;
 
   private:
    explicit element(const std::uint8_t* raw,
                     std::uint32_t length,
                     std::uint32_t offset,
                     std::uint32_t keylen);
 
    // Construct an invalid element with a key. Useful for exceptions.
    explicit element(const stdx::string_view key);
 
    friend ::bsoncxx::v_noabi::array::element;
    friend ::bsoncxx::v_noabi::document::view;
 
    const std::uint8_t* _raw;
    std::uint32_t _length;
    std::uint32_t _offset;
    std::uint32_t _keylen;
    // _key will only exist when a caller attempts to find a key in the BSON but is unsuccessful.
    // The key is stored for a more helpful error message if the user tries to access the value of
    // a key that does not exist.
    stdx::optional<stdx::string_view> _key;
};
 
 
BSONCXX_ABI_EXPORT_CDECL(bool) operator==(const element& elem, const types::bson_value::view& v);
 
BSONCXX_ABI_EXPORT_CDECL(bool) operator==(const types::bson_value::view& v, const element& elem);
 
BSONCXX_ABI_EXPORT_CDECL(bool) operator!=(const element& elem, const types::bson_value::view& v);
 
BSONCXX_ABI_EXPORT_CDECL(bool) operator!=(const types::bson_value::view& v, const element& elem);
 
 
}  // namespace document
}  // namespace v_noabi
}  // namespace bsoncxx
 
namespace bsoncxx {
namespace document {
 
using ::bsoncxx::v_noabi::document::operator==;
using ::bsoncxx::v_noabi::document::operator!=;
 
}  // namespace document
}  // namespace bsoncxx
 
#include <bsoncxx/config/postlude.hpp>
 
 
#if defined(BSONCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
 
namespace bsoncxx {
namespace document {
 
bool operator==(const v_noabi::document::element& elem, const v_noabi::types::bson_value::view& v);
 
bool operator==(const v_noabi::types::bson_value::view& v, const v_noabi::document::element& elem);
 
bool operator!=(const v_noabi::document::element& elem, const v_noabi::types::bson_value::view& v);
 
bool operator!=(const v_noabi::types::bson_value::view& v, const v_noabi::document::element& elem);
 
}  // namespace document
}  // namespace bsoncxx
 
#endif  // defined(BSONCXX_PRIVATE_DOXYGEN_PREPROCESSOR)