types.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 <chrono>
#include <cstring>
#include <string>
 
#include <bsoncxx/types-fwd.hpp>
 
#include <bsoncxx/array/view.hpp>
#include <bsoncxx/decimal128.hpp>
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/oid.hpp>
#include <bsoncxx/stdx/string_view.hpp>
#include <bsoncxx/stdx/type_traits.hpp>
 
#include <bsoncxx/config/prelude.hpp>
 
BSONCXX_PUSH_WARNINGS();
BSONCXX_DISABLE_WARNING(GNU("-Wfloat-equal"));
 
namespace bsoncxx {
namespace v_noabi {
 
enum class type : std::uint8_t {
    k_double = 0x01,      
    k_string = 0x02,      
    k_utf8 = 0x02,        
    k_document = 0x03,    
    k_array = 0x04,       
    k_binary = 0x05,      
    k_undefined = 0x06,   
    k_oid = 0x07,         
    k_bool = 0x08,        
    k_date = 0x09,        
    k_null = 0x0A,        
    k_regex = 0x0B,       
    k_dbpointer = 0x0C,   
    k_code = 0x0D,        
    k_symbol = 0x0E,      
    k_codewscope = 0x0F,  
    k_int32 = 0x10,       
    k_timestamp = 0x11,   
    k_int64 = 0x12,       
    k_decimal128 = 0x13,  
    k_maxkey = 0x7F,      
    k_minkey = 0xFF,      
};
 
enum class binary_sub_type : std::uint8_t {
    k_binary = 0x00,             
    k_function = 0x01,           
    k_binary_deprecated = 0x02,  
    k_uuid_deprecated = 0x03,    
    k_uuid = 0x04,               
    k_md5 = 0x05,                
    k_encrypted = 0x06,          
    k_column = 0x07,             
    k_sensitive = 0x08,          
    k_user = 0x80,               
};
 
BSONCXX_ABI_EXPORT_CDECL(std::string) to_string(type rhs);
 
BSONCXX_ABI_EXPORT_CDECL(std::string) to_string(binary_sub_type rhs);
 
namespace types {
 
struct b_double {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_double;
 
    double value;
 
    operator double() const {
        return value;
    }
};
 
inline bool operator==(const b_double& lhs, const b_double& rhs) {
    return lhs.value == rhs.value;
}
 
struct b_string {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_string;
 
    template <typename T, detail::requires_not_t<int, detail::is_alike<b_string, T>> = 0>
    explicit b_string(T&& t) : value(std::forward<T>(t)) {}
 
    stdx::string_view value;
 
    operator stdx::string_view() const {
        return value;
    }
};
 
inline bool operator==(const b_string& lhs, const b_string& rhs) {
    return lhs.value == rhs.value;
}
 
BSONCXX_DEPRECATED typedef b_string b_utf8;
 
struct b_document {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_document;
 
    document::view value;
 
    operator document::view() const {
        return value;
    }
 
    document::view view() {
        return value;
    }
};
 
inline bool operator==(const b_document& lhs, const b_document& rhs) {
    return lhs.value == rhs.value;
}
 
struct b_array {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_array;
 
    array::view value;
 
    operator array::view() const {
        return value;
    }
};
 
inline bool operator==(const b_array& lhs, const b_array& rhs) {
    return lhs.value == rhs.value;
}
 
struct b_binary {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_binary;
 
    binary_sub_type sub_type;
    uint32_t size;
    const uint8_t* bytes;
};
 
inline bool operator==(const b_binary& lhs, const b_binary& rhs) {
    return lhs.sub_type == rhs.sub_type && lhs.size == rhs.size &&
           (!lhs.size || (std::memcmp(lhs.bytes, rhs.bytes, lhs.size) == 0));
}
 
struct b_undefined {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_undefined;
};
 
inline bool operator==(const b_undefined&, const b_undefined&) {
    return true;
}
 
struct b_oid {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_oid;
 
    oid value;
};
 
inline bool operator==(const b_oid& lhs, const b_oid& rhs) {
    return lhs.value == rhs.value;
}
 
struct b_bool {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_bool;
 
    bool value;
 
    operator bool() const {
        return value;
    }
};
 
inline bool operator==(const b_bool& lhs, const b_bool& rhs) {
    return lhs.value == rhs.value;
}
 
struct b_date {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_date;
 
    explicit b_date(std::chrono::milliseconds value) : value(value) {}
 
    explicit b_date(const std::chrono::system_clock::time_point& tp)
        : value(std::chrono::duration_cast<std::chrono::milliseconds>(tp.time_since_epoch())) {}
 
    std::chrono::milliseconds value;
 
    operator int64_t() const {
        return value.count();
    }
 
    int64_t to_int64() const {
        return value.count();
    }
 
    operator std::chrono::system_clock::time_point() const {
        return std::chrono::system_clock::time_point(
            std::chrono::duration_cast<std::chrono::system_clock::duration>(value));
    }
};
 
inline bool operator==(const b_date& lhs, const b_date& rhs) {
    return lhs.value == rhs.value;
}
 
struct b_null {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_null;
};
 
inline bool operator==(const b_null&, const b_null&) {
    return true;
}
 
struct b_regex {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_regex;
 
    template <typename T,
              typename U = stdx::string_view,
              detail::requires_not_t<int, detail::is_alike<b_regex, T>> = 0>
    explicit b_regex(T&& regex, U&& options = U{})
        : regex(std::forward<T>(regex)), options(std::forward<U>(options)) {}
 
    stdx::string_view regex;
    stdx::string_view options;
};
 
inline bool operator==(const b_regex& lhs, const b_regex& rhs) {
    return lhs.regex == rhs.regex && lhs.options == rhs.options;
}
 
struct b_dbpointer {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_dbpointer;
 
    stdx::string_view collection;
    oid value;
};
 
inline bool operator==(const b_dbpointer& lhs, const b_dbpointer& rhs) {
    return lhs.collection == rhs.collection && lhs.value == rhs.value;
}
 
struct b_code {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_code;
 
    template <typename T, detail::requires_not_t<int, detail::is_alike<b_code, T>> = 0>
    explicit b_code(T&& t) : code(std::forward<T>(t)) {}
 
    stdx::string_view code;
 
    operator stdx::string_view() const {
        return code;
    }
};
 
inline bool operator==(const b_code& lhs, const b_code& rhs) {
    return lhs.code == rhs.code;
}
 
struct b_symbol {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_symbol;
 
    template <typename T, detail::requires_not_t<int, detail::is_alike<b_symbol, T>> = 0>
    explicit b_symbol(T&& t) : symbol(std::forward<T>(t)) {}
 
    stdx::string_view symbol;
 
    operator stdx::string_view() const {
        return symbol;
    }
};
 
inline bool operator==(const b_symbol& lhs, const b_symbol& rhs) {
    return lhs.symbol == rhs.symbol;
}
 
struct b_codewscope {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_codewscope;
 
    template <typename T,
              typename U,
              detail::requires_not_t<int, detail::is_alike<b_codewscope, T>> = 0>
    explicit b_codewscope(T&& code, U&& scope)
        : code(std::forward<T>(code)), scope(std::forward<U>(scope)) {}
 
    stdx::string_view code;
    document::view scope;
};
 
inline bool operator==(const b_codewscope& lhs, const b_codewscope& rhs) {
    return lhs.code == rhs.code && lhs.scope == rhs.scope;
}
 
struct b_int32 {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_int32;
 
    int32_t value;
 
    operator int32_t() const {
        return value;
    }
};
 
inline bool operator==(const b_int32& lhs, const b_int32& rhs) {
    return lhs.value == rhs.value;
}
 
struct b_timestamp {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_timestamp;
 
    uint32_t increment;
    uint32_t timestamp;
};
 
inline bool operator==(const b_timestamp& lhs, const b_timestamp& rhs) {
    return lhs.increment == rhs.increment && lhs.timestamp == rhs.timestamp;
}
 
struct b_int64 {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_int64;
 
    int64_t value;
 
    operator int64_t() const {
        return value;
    }
};
 
inline bool operator==(const b_int64& lhs, const b_int64& rhs) {
    return lhs.value == rhs.value;
}
 
struct b_decimal128 {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_decimal128;
 
    decimal128 value;
 
    template <typename T, detail::requires_not_t<int, detail::is_alike<b_decimal128, T>> = 0>
    explicit b_decimal128(T&& t) : value(std::forward<T>(t)) {}
};
 
inline bool operator==(const b_decimal128& lhs, const b_decimal128& rhs) {
    return lhs.value == rhs.value;
}
 
struct b_minkey {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_minkey;
};
 
inline bool operator==(const b_minkey&, const b_minkey&) {
    return true;
}
 
struct b_maxkey {
    BSONCXX_ABI_EXPORT static constexpr auto type_id = type::k_maxkey;
};
 
inline bool operator==(const b_maxkey&, const b_maxkey&) {
    return true;
}
 
inline bool operator!=(const b_double& lhs, const b_double& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_string& lhs, const b_string& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_document& lhs, const b_document& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_array& lhs, const b_array& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_binary& lhs, const b_binary& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_undefined& lhs, const b_undefined& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_oid& lhs, const b_oid& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_bool& lhs, const b_bool& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_date& lhs, const b_date& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_null& lhs, const b_null& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_regex& lhs, const b_regex& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_dbpointer& lhs, const b_dbpointer& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_code& lhs, const b_code& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_symbol& lhs, const b_symbol& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_codewscope& lhs, const b_codewscope& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_int32& lhs, const b_int32& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_timestamp& lhs, const b_timestamp& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_int64& lhs, const b_int64& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_decimal128& lhs, const b_decimal128& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_minkey& lhs, const b_minkey& rhs) {
    return !(lhs == rhs);
}
 
inline bool operator!=(const b_maxkey& lhs, const b_maxkey& rhs) {
    return !(lhs == rhs);
}
 
}  // namespace types
}  // namespace v_noabi
}  // namespace bsoncxx
 
BSONCXX_POP_WARNINGS();
 
namespace bsoncxx {
 
using ::bsoncxx::v_noabi::to_string;
 
}  // namespace bsoncxx
 
namespace bsoncxx {
namespace types {
 
using ::bsoncxx::v_noabi::types::b_utf8;  // Deprecated.
 
using ::bsoncxx::v_noabi::types::operator==;
using ::bsoncxx::v_noabi::types::operator!=;
 
}  // namespace types
}  // namespace bsoncxx
 
#include <bsoncxx/config/postlude.hpp>
 
 
#if defined(BSONCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
 
namespace bsoncxx {
 
std::string to_string(v_noabi::type rhs);
 
std::string to_string(v_noabi::binary_sub_type rhs);
 
namespace types {
 
struct b_utf8 {};
 
bool operator==(const v_noabi::types::b_double& lhs, const v_noabi::types::b_double& rhs);
 
bool operator==(const v_noabi::types::b_string& lhs, const v_noabi::types::b_string& rhs);
 
bool operator==(const v_noabi::types::b_document& lhs, const v_noabi::types::b_document& rhs);
 
bool operator==(const v_noabi::types::b_array& lhs, const v_noabi::types::b_array& rhs);
 
bool operator==(const v_noabi::types::b_binary& lhs, const v_noabi::types::b_binary& rhs);
 
bool operator==(const v_noabi::types::b_undefined&, const v_noabi::types::b_undefined&);
 
bool operator==(const v_noabi::types::b_oid& lhs, const v_noabi::types::b_oid& rhs);
 
bool operator==(const v_noabi::types::b_bool& lhs, const v_noabi::types::b_bool& rhs);
 
bool operator==(const v_noabi::types::b_date& lhs, const v_noabi::types::b_date& rhs);
 
bool operator==(const v_noabi::types::b_null&, const v_noabi::types::b_null&);
 
bool operator==(const v_noabi::types::b_regex& lhs, const v_noabi::types::b_regex& rhs);
 
bool operator==(const v_noabi::types::b_dbpointer& lhs, const v_noabi::types::b_dbpointer& rhs);
 
bool operator==(const v_noabi::types::b_code& lhs, const v_noabi::types::b_code& rhs);
 
bool operator==(const v_noabi::types::b_symbol& lhs, const v_noabi::types::b_symbol& rhs);
 
bool operator==(const v_noabi::types::b_codewscope& lhs, const v_noabi::types::b_codewscope& rhs);
 
bool operator==(const v_noabi::types::b_int32& lhs, const v_noabi::types::b_int32& rhs);
 
bool operator==(const v_noabi::types::b_timestamp& lhs, const v_noabi::types::b_timestamp& rhs);
 
bool operator==(const v_noabi::types::b_int64& lhs, const v_noabi::types::b_int64& rhs);
 
bool operator==(const v_noabi::types::b_decimal128& lhs, const v_noabi::types::b_decimal128& rhs);
 
bool operator==(const v_noabi::types::b_minkey&, const v_noabi::types::b_minkey&);
 
bool operator==(const v_noabi::types::b_maxkey&, const v_noabi::types::b_maxkey&);
 
bool operator!=(const v_noabi::types::b_double& lhs, const v_noabi::types::b_double& rhs);
 
bool operator!=(const v_noabi::types::b_string& lhs, const v_noabi::types::b_string& rhs);
 
bool operator!=(const v_noabi::types::b_document& lhs, const v_noabi::types::b_document& rhs);
 
bool operator!=(const v_noabi::types::b_array& lhs, const v_noabi::types::b_array& rhs);
 
bool operator!=(const v_noabi::types::b_binary& lhs, const v_noabi::types::b_binary& rhs);
 
bool operator!=(const v_noabi::types::b_undefined& lhs, const v_noabi::types::b_undefined& rhs);
 
bool operator!=(const v_noabi::types::b_oid& lhs, const v_noabi::types::b_oid& rhs);
 
bool operator!=(const v_noabi::types::b_bool& lhs, const v_noabi::types::b_bool& rhs);
 
bool operator!=(const v_noabi::types::b_date& lhs, const v_noabi::types::b_date& rhs);
 
bool operator!=(const v_noabi::types::b_null& lhs, const v_noabi::types::b_null& rhs);
 
bool operator!=(const v_noabi::types::b_regex& lhs, const v_noabi::types::b_regex& rhs);
 
bool operator!=(const v_noabi::types::b_dbpointer& lhs, const v_noabi::types::b_dbpointer& rhs);
 
bool operator!=(const v_noabi::types::b_code& lhs, const v_noabi::types::b_code& rhs);
 
bool operator!=(const v_noabi::types::b_symbol& lhs, const v_noabi::types::b_symbol& rhs);
 
bool operator!=(const v_noabi::types::b_codewscope& lhs, const v_noabi::types::b_codewscope& rhs);
 
bool operator!=(const v_noabi::types::b_int32& lhs, const v_noabi::types::b_int32& rhs);
 
bool operator!=(const v_noabi::types::b_timestamp& lhs, const v_noabi::types::b_timestamp& rhs);
 
bool operator!=(const v_noabi::types::b_int64& lhs, const v_noabi::types::b_int64& rhs);
 
bool operator!=(const v_noabi::types::b_decimal128& lhs, const v_noabi::types::b_decimal128& rhs);
 
bool operator!=(const v_noabi::types::b_minkey& lhs, const v_noabi::types::b_minkey& rhs);
 
bool operator!=(const v_noabi::types::b_maxkey& lhs, const v_noabi::types::b_maxkey& rhs);
 
}  // namespace types
 
}  // namespace bsoncxx
 
#endif  // defined(BSONCXX_PRIVATE_DOXYGEN_PREPROCESSOR)