value.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/value-fwd.hpp> // IWYU pragma: export
 
//
 
#include <bsoncxx/v1/detail/type_traits.hpp>
#include <bsoncxx/v1/document/value.hpp> // IWYU pragma: export
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <cstdint>
#include <cstdlib>
#include <memory>
#include <type_traits>
#include <utility>
 
#include <bsoncxx/array/view.hpp>
#include <bsoncxx/document/element.hpp>
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/stdx/type_traits.hpp> // IWYU pragma: keep: backward compatibity, to be removed.
 
#include <bsoncxx/config/prelude.hpp>
 
namespace bsoncxx {
namespace v_noabi {
namespace document {

class value {
   private:
    v1::document::value _value;
    std::size_t _length;
 
   public:
    using deleter_type = void(BSONCXX_ABI_CDECL*)(std::uint8_t*);

    using unique_ptr_type = std::unique_ptr<std::uint8_t[], deleter_type>;

    using const_iterator = v_noabi::document::view::const_iterator;

    using iterator = const_iterator;
 
    ~value() = default;
 
    value(value&&) = default;
    value& operator=(value&&) = default;
 
    value(value const& other) : value{other.view()} {}
 
    value& operator=(value const& other) {
        *this = value{other.view()};
        return *this;
    }

    value(std::uint8_t* data, std::size_t length, deleter_type deleter)
        : _value{data, std::move(deleter)}, _length{length} {}

    value(unique_ptr_type ptr, std::size_t length) : _value{std::move(ptr)}, _length{length} {}

    explicit BSONCXX_ABI_EXPORT_CDECL() value(v_noabi::document::view view);

    template <typename T, detail::requires_not_t<int, std::is_same<T, array::view>> = 0>
    explicit value(T const& t) : value({}) {
        to_bson(t, *this);
    }

    template <typename T>
    value& operator=(T const& t) {
        *this = value{t};
        return *this;
    }

    explicit operator v1::document::value() const& {
        return _value;
    }

    explicit operator v1::document::value() && {
        _length = 0u;
        return std::move(_value);
    }

    const_iterator cbegin() const {
        return this->view().cbegin();
    }

    const_iterator cend() const {
        return this->view().cend();
    }

    const_iterator begin() const {
        return this->view().begin();
    }

    const_iterator end() const {
        return this->view().end();
    }

    const_iterator find(v1::stdx::string_view key) const {
        return const_iterator{*_value.find(key)};
    }

    v_noabi::document::element operator[](v1::stdx::string_view key) const {
        return _value.operator[](key);
    }

    std::uint8_t const* data() const {
        return _value.data();
    }

    std::size_t size() const {
        return _length; // Do NOT use _value.size().
    }

    std::size_t length() const {
        return _length; // Do NOT use _value.length().
    }

    bool empty() const {
        return _length == 5; // Do NOT use _value.empty().
    }

    v_noabi::document::view view() const noexcept {
        return {_value.data(), _length}; // Do NOT use _value.view().
    }

    /* explicit(false) */ operator v_noabi::document::view() const noexcept {
        return this->view();
    }

    template <typename T>
    T get() {
        T temp{};
        from_bson(temp, this->view());
        return temp;
    }

    template <typename T>
    void get(T& t) {
        from_bson(t, this->view());
    }

    unique_ptr_type release() {
        auto ptr = _value.release();
 
        // Invariant: the underlying deleter type MUST be `deleter_type`.
        auto const deleter_ptr = ptr.get_deleter().target<deleter_type>();
 
        // Invariant: `ptr` implies `deleter_ptr`, but not the reverse.
        return {ptr.release(), deleter_ptr ? *deleter_ptr : nullptr};
    }

    void reset(v_noabi::document::view view) {
        _value.reset(to_v1(view));
    }
};


inline bool operator==(value const& lhs, value const& rhs) {
    return (lhs.view() == rhs.view());
}

inline bool operator!=(value const& lhs, value const& rhs) {
    return !(lhs == rhs);
}

 
} // namespace document
} // namespace v_noabi
} // namespace bsoncxx
 
namespace bsoncxx {
namespace v_noabi {

inline v_noabi::document::value from_v1(v1::document::value const& v) {
    return v_noabi::document::value{from_v1(v.view())};
}

BSONCXX_ABI_EXPORT_CDECL(v_noabi::document::value) from_v1(v1::document::value&& v);

inline v1::document::value to_v1(v_noabi::document::value v) {
    return v1::document::value{std::move(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>