SecurityToken.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
 
namespace Arp::Base::Commons::Security
{
 
class ARP_EXPORT SecurityToken
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Value = uint32;
 
public: // construction
    SecurityToken(Value value = GetNone());
    // canonical construction/destruction/assignment
    SecurityToken(const SecurityToken& arg);
    SecurityToken(SecurityToken&& arg)noexcept;
    SecurityToken& operator=(const SecurityToken& arg);
    SecurityToken& operator=(SecurityToken&& arg)noexcept;
    ~SecurityToken(void);
 
public: // global operators
    ARP_EXPORT friend bool operator<(const SecurityToken& lhs, const SecurityToken& rhs);
    ARP_EXPORT friend bool operator==(const SecurityToken& lhs, const SecurityToken& rhs);
 
    friend std::ostream& operator<<(std::ostream& os, const SecurityToken& token)
    {
        os << token.ToString();
        return os;
    }
 
    friend std::istream& operator>>(std::istream& is, SecurityToken& token)
    {
        Value value{ 0 };
        is >> value;
        token = SecurityToken(value);
        return is;
    }
 
public: // static operations
    static Value  GetNone(void);
    static size_t GetSize(void);
 
public: // setter/getter operations
    bool    HasValue(void)const;
    Value   GetValue(void)const;
 
public: // operations
    String  ToString(void)const;
 
public: // internal operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl, true>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
} // end of namespace Arp::Base::Commons::Security
 
// template specialization of SecurityToken formatter
template<> struct fmt::formatter<Arp::Base::Commons::Security::SecurityToken> : public fmt::ostream_formatter
{
};