oid.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/v1/oid-fwd.hpp> // IWYU pragma: export
 
//
 
#include <bsoncxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/config/export.hpp>
#include <bsoncxx/v1/detail/macros.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <array>
#include <cstddef>
#include <cstdint>
#include <ctime>
#include <string>
#include <system_error>
#include <type_traits>
 
namespace bsoncxx {
namespace v1 {

class oid {
   public:
    static constexpr std::size_t k_oid_length = 12;
 
   private:
    std::array<std::uint8_t, k_oid_length> _bytes;
 
   public:
    BSONCXX_ABI_EXPORT_CDECL() oid();

    BSONCXX_ABI_EXPORT_CDECL() oid(std::uint8_t const* bytes, std::size_t len);

    explicit BSONCXX_ABI_EXPORT_CDECL() oid(v1::stdx::string_view str);

    static std::size_t size() {
        return k_oid_length;
    }

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

    BSONCXX_ABI_EXPORT_CDECL(std::string) to_string() const;

    BSONCXX_ABI_EXPORT_CDECL(std::time_t) get_time_t() const;

    BSONCXX_ABI_EXPORT_CDECL(int) compare(oid const& other) const;

    friend bool operator==(oid const& lhs, oid const& rhs) {
        return lhs.compare(rhs) == 0;
    }

    friend bool operator!=(oid const& lhs, oid const& rhs) {
        return lhs.compare(rhs) != 0;
    }

    friend bool operator<(oid const& lhs, oid const& rhs) {
        return lhs.compare(rhs) < 0;
    }

    friend bool operator<=(oid const& lhs, oid const& rhs) {
        return lhs.compare(rhs) <= 0;
    }

    friend bool operator>(oid const& lhs, oid const& rhs) {
        return lhs.compare(rhs) > 0;
    }

    friend bool operator>=(oid const& lhs, oid const& rhs) {
        return lhs.compare(rhs) >= 0;
    }

    enum class errc {
        zero,           
        null_bytes_ptr, 
        invalid_length, 
        empty_string,   
        invalid_string, 
    };

    static BSONCXX_ABI_EXPORT_CDECL(std::error_category const&) error_category();

    friend std::error_code make_error_code(errc v) {
        return {static_cast<int>(v), error_category()};
    }
 
    class internal;
 
   private:
    struct for_overwrite_tag {};
 
    /* explicit(false) */ oid(for_overwrite_tag) : _bytes{} {}
};
 
BSONCXX_PRIVATE_INLINE_CXX17 constexpr std::size_t oid::k_oid_length;
 
} // namespace v1
} // namespace bsoncxx
 
template <>
struct std::is_error_code_enum<bsoncxx::v1::oid::errc> : true_type {};
 
#include <bsoncxx/v1/detail/postlude.hpp>