element.hpp

// Copyright 2014 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/stdx/optional.hpp>
#include <bsoncxx/stdx/string_view.hpp>
 
#include <bsoncxx/config/prelude.hpp>
 
namespace bsoncxx {
inline namespace v_noabi {
enum class type : std::uint8_t;
enum class binary_sub_type : std::uint8_t;
 
namespace types {
struct b_eod;
struct b_double;
struct b_string;
struct b_document;
struct b_array;
struct b_binary;
struct b_undefined;
struct b_oid;
struct b_bool;
struct b_date;
struct b_null;
struct b_regex;
struct b_dbpointer;
struct b_code;
struct b_symbol;
struct b_codewscope;
struct b_int32;
struct b_timestamp;
struct b_int64;
struct b_decimal128;
struct b_minkey;
struct b_maxkey;
 
namespace bson_value {
class value;
class view;
}  // namespace bson_value
 
}  // namespace types
 
namespace array {
class element;
}  // namespace array
 
namespace document {
 
class BSONCXX_API element {
   public:
    element();
 
    explicit operator bool() const;
 
    const std::uint8_t* raw() const;
 
    std::uint32_t length() const;
 
    std::uint32_t offset() const;
 
    bsoncxx::type type() const;
 
    stdx::string_view key() const;
 
    std::uint32_t keylen() const;
 
    types::b_double get_double() const;
 
    BSONCXX_DEPRECATED types::b_string get_utf8() const;
 
    types::b_string get_string() const;
 
    types::b_document get_document() const;
 
    types::b_array get_array() const;
 
    types::b_binary get_binary() const;
 
    types::b_undefined get_undefined() const;
 
    types::b_oid get_oid() const;
 
    types::b_bool get_bool() const;
 
    types::b_date get_date() const;
 
    types::b_null get_null() const;
 
    types::b_regex get_regex() const;
 
    types::b_dbpointer get_dbpointer() const;
 
    types::b_code get_code() const;
 
    types::b_symbol get_symbol() const;
 
    types::b_codewscope get_codewscope() const;
 
    types::b_int32 get_int32() const;
 
    types::b_timestamp get_timestamp() const;
 
    types::b_int64 get_int64() const;
 
    types::b_decimal128 get_decimal128() const;
 
    types::b_minkey get_minkey() const;
 
    types::b_maxkey get_maxkey() const;
 
    types::bson_value::view get_value() const;
 
    types::bson_value::value get_owning_value() const;
 
    element operator[](stdx::string_view key) const;
 
    array::element operator[](std::uint32_t i) const;
 
   private:
    BSONCXX_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.
    BSONCXX_PRIVATE explicit element(const stdx::string_view key);
 
    friend class view;
    friend class array::element;
 
    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_API bool BSONCXX_CALL operator==(const element& elem, const types::bson_value::view& v);
BSONCXX_API bool BSONCXX_CALL operator==(const types::bson_value::view& v, const element& elem);
 
BSONCXX_API bool BSONCXX_CALL operator!=(const element& elem, const types::bson_value::view& v);
BSONCXX_API bool BSONCXX_CALL operator!=(const types::bson_value::view& v, const element& elem);
 
}  // namespace document
 
}  // namespace v_noabi
}  // namespace bsoncxx
 
#include <bsoncxx/config/postlude.hpp>