Uuid.h

Go to the documentation of this file.

/*!********************************************************************
 
 Audacity: A Digital Audio Editor
 
 @file Uuid.h
 @brief Declare a class to generate and parse UUIDs
 
 Dmitry Vedenko
 **********************************************************************/
 
#pragma once
 
#include <array>
#include <cstdint>
#include <string>
 
namespace audacity
{
 
class UUID_API Uuid final
{
public:
   using Bytes = std::array<uint8_t, 16>;
 
   Uuid();
 
   explicit Uuid(const Bytes& data) noexcept;
 
   static Uuid Generate();
 
   static Uuid FromString(const std::string& str);
 
   bool IsNil() const noexcept;
 
   explicit operator bool() const noexcept;
 
   // Comparison is performed lexicographically.
 
   bool operator==(const Uuid& other) const noexcept;
   bool operator!=(const Uuid& other) const noexcept;
 
   bool operator>(const Uuid& other) const noexcept;
   bool operator>=(const Uuid& other) const noexcept;
 
   bool operator<(const Uuid& other) const noexcept;
   bool operator<=(const Uuid& other) const noexcept;
 
   const Bytes& ToBytes() const noexcept;
   
   std::string ToString() const;
 
   std::string ToHexString() const;
 
   std::size_t GetHash() const noexcept;
 
private:
   Bytes mData;
};
 
} // namespace audacity
 
namespace std
{
template <> struct UUID_API hash<audacity::Uuid>
{
   std::size_t operator()(const audacity::Uuid& uuid) const noexcept
   {
      return uuid.GetHash();
   }
};
} // namespace std