Botan::UUID Class Reference

#include <uuid.h>

Public Member Functions
const std::vector< uint8_t > &	binary_value () const
bool	is_valid () const
bool	operator!= (const UUID &other) const
bool	operator== (const UUID &other) const
std::string	to_string () const
	UUID ()=default
BOTAN_FUTURE_EXPLICIT	UUID (const std::vector< uint8_t > &blob)
BOTAN_FUTURE_EXPLICIT	UUID (RandomNumberGenerator &rng)
BOTAN_FUTURE_EXPLICIT	UUID (std::string_view uuid_str)

Detailed Description

Definition at line 21 of file uuid.h.

Constructor & Destructor Documentation

UUID() [1/4]

Botan::UUID::UUID ( )

default

Create an uninitialized UUID object

References BOTAN_FUTURE_EXPLICIT, to_string(), and UUID().

Referenced by operator!=(), operator==(), and UUID().

UUID() [2/4]

Botan::UUID::UUID

(

RandomNumberGenerator &

rng

)

Create a random UUID

Definition at line 18 of file uuid.cpp.

                                     {
   m_uuid.resize(16);
   rng.randomize(m_uuid.data(), m_uuid.size());
 
   // Mark as a random v4 UUID (RFC 4122 sec 4.4)
   m_uuid[6] = 0x40 | (m_uuid[6] & 0x0F);
 
   // Set reserved bits
   m_uuid[8] = 0x80 | (m_uuid[8] & 0x3F);
}

References Botan::RandomNumberGenerator::randomize().

UUID() [3/4]

Botan::UUID::UUID

(

const std::vector< uint8_t > &

blob

)

Load a UUID from a 16 byte vector

Definition at line 29 of file uuid.cpp.

                                         {
   if(blob.size() != 16) {
      throw Invalid_Argument("Bad UUID blob " + hex_encode(blob));
   }
 
   m_uuid = blob;
}

References Botan::hex_encode().

UUID() [4/4]

Botan::UUID::UUID

(

std::string_view

uuid_str

)

Decode a UUID string

Definition at line 37 of file uuid.cpp.

                                  {
   if(uuid_str.size() != 36 || uuid_str[8] != '-' || uuid_str[13] != '-' || uuid_str[18] != '-' ||
      uuid_str[23] != '-') {
      throw Invalid_Argument(fmt("Bad UUID '{}'", uuid_str));
   }
 
   std::string just_hex;
   for(const char c : uuid_str) {
      if(c == '-') {
         continue;
      }
 
      just_hex += c;
   }
 
   m_uuid = hex_decode(just_hex);
 
   if(m_uuid.size() != 16) {
      throw Invalid_Argument(fmt("Bad UUID '{}'", uuid_str));
   }
}

References Botan::fmt(), and Botan::hex_decode().

Member Function Documentation

binary_value()

const std::vector< uint8_t > & Botan::UUID::binary_value ( ) const

inline

Definition at line 48 of file uuid.h.

{ return m_uuid; }

is_valid()

bool Botan::UUID::is_valid ( ) const

inline

Definition at line 54 of file uuid.h.

{ return m_uuid.size() == 16; }

Referenced by to_string().

operator!=()

bool Botan::UUID::operator!= ( const UUID & other ) const

inline

Definition at line 52 of file uuid.h.

{ return !(*this == other); }

References UUID().

operator==()

bool Botan::UUID::operator== ( const UUID & other ) const

inline

Definition at line 50 of file uuid.h.

{ return m_uuid == other.m_uuid; }

References UUID().

to_string()

std::string Botan::UUID::to_string

(

)

const

Convert the UUID to a string

Definition at line 59 of file uuid.cpp.

                                {
   if(!is_valid()) {
      throw Invalid_State("UUID object is empty cannot convert to string");
   }
 
   const std::string raw = hex_encode(m_uuid);
 
   std::ostringstream formatted;
 
   for(size_t i = 0; i != raw.size(); ++i) {
      if(i == 8 || i == 12 || i == 16 || i == 20) {
         formatted << "-";
      }
      formatted << raw[i];
   }
 
   return formatted.str();
}

References Botan::hex_encode(), and is_valid().

Referenced by UUID().

---

The documentation for this class was generated from the following files:

• src/lib/utils/uuid/uuid.h
• src/lib/utils/uuid/uuid.cpp