oid.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 <array>
#include <ctime>
#include <string>

#include <bsoncxx/stdx/string_view.hpp>

#include <bsoncxx/config/prelude.hpp>

namespace bsoncxx {
BSONCXX_INLINE_NAMESPACE_BEGIN

class BSONCXX_API oid {
   public:
    oid();

    struct init_tag_t {};

    // TODO(MSVC): Ideally this would be constexpr, but VS2015U1 can't
    // handle it.
    //
    // See https://connect.microsoft.com/VisualStudio/feedback/details/2092790
    //
    BSONCXX_DEPRECATED static const init_tag_t init_tag;

    BSONCXX_DEPRECATED explicit oid(init_tag_t tag);

    struct init_tag_t_deprecated {};
    static const init_tag_t_deprecated init_tag_deprecated;
    explicit oid(init_tag_t_deprecated);

    explicit oid(const char* bytes, std::size_t len);

    explicit oid(const bsoncxx::stdx::string_view& str);

    std::string to_string() const;

    friend BSONCXX_API bool BSONCXX_CALL operator<(const oid& lhs, const oid& rhs);
    friend BSONCXX_API bool BSONCXX_CALL operator>(const oid& lhs, const oid& rhs);
    friend BSONCXX_API bool BSONCXX_CALL operator<=(const oid& lhs, const oid& rhs);
    friend BSONCXX_API bool BSONCXX_CALL operator>=(const oid& lhs, const oid& rhs);
    friend BSONCXX_API bool BSONCXX_CALL operator==(const oid& lhs, const oid& rhs);
    friend BSONCXX_API bool BSONCXX_CALL operator!=(const oid& lhs, const oid& rhs);

    BSONCXX_DEPRECATED explicit operator bool() const;
    bool operator_bool_deprecated() const;

    std::time_t get_time_t() const;

    const char* bytes() const;

   private:
    friend BSONCXX_PRIVATE int oid_compare(const oid& lhs, const oid& rhs);

    std::array<char, 12> _bytes;
};

BSONCXX_INLINE_NAMESPACE_END
}  // namespace bsoncxx

#include <bsoncxx/config/postlude.hpp>