uuid.h File Reference

#include <stdint.h>
#include <string.h>
#include "lib.h"
#include "list.h"

Go to the source code of this file.

Classes
struct	UUID
	UUID type Layout taken from: https://en.wikipedia.org/wiki/Universally_unique_identifier#Binary_representation. More...
struct	UUID_Str
	This is useful for printing UUID's. More...
struct	HexByte
	A hexadecimal Byte. More...

Functions
	DefList (HexByte) UUID_Str utoa(UUID uuid)
	Convert a UUID into a string.
Buffer	UUID_serialize (UUID uuid)
	Serialize a UUID into a Buffer.
UUID	UUID_deserialize (Buffer buf)
	Deserialize a Buffer into a UUID.
uint64_t	from_hex (Str str, size_t max_len)
	Converts a wire format string into a 64-bit integer.
UUID	new_uuid (void)
	Creates a new UUID.
HexByte	to_hex1 (unsigned char c)
	Converts a single byte to the character representation.
ListHexByte	to_hex (uint64_t n)
	Converts an entire 64-bit integer into the character representation.
void	ListHexByte_print (ListHexByte list, char end)
	Print a list of hex bytes.
bool	UUID_eq (UUID lhs, UUID rhs)
	Compare 2 UUID's.

Function Documentation

DefList()

DefList

(

HexByte

)

Convert a UUID into a string.

In order to actually get the string, you have to do:

utoa(your_id_here).uuid;

INFO: The caller does not have to free the memory! ;)

Parameters

uuid	the UUID that you want a string for

Returns

a UUID_Str representing that UUID

from_hex()

uint64_t from_hex	(	Str	str,
		size_t	max_len )

Converts a wire format string into a 64-bit integer.

Parameters

str	the wire format string to convert
max_len	the amount of characters to read from the string

Returns

a 64-bit integer with the value of the wire format

ListHexByte_print()

void ListHexByte_print	(	ListHexByte	list,
		char	end )

Print a list of hex bytes.

Parameters

list	the list of hex bytes to print
end	the character to end the print with

new_uuid()

UUID new_uuid

(

void

)

Creates a new UUID.

The UUID comes from /proc/sys/kernel/random/uuid

Returns

a new UUID

to_hex()

ListHexByte to_hex

(

uint64_t

n

)

Converts an entire 64-bit integer into the character representation.

Caller must free memory.

Parameters

n	the number to convert

Returns

the List of bytes the number represents

to_hex1()

HexByte to_hex1

(

unsigned char

c

)

Converts a single byte to the character representation.

Parameters

c	the byte to convert

Returns

a HexByte that represents that byte

UUID_deserialize()

UUID UUID_deserialize

(

Buffer

buf

)

Deserialize a Buffer into a UUID.

Parameters

buf	The Buffer you want to deserialize

Returns

The UUID that the Buffer represents

UUID_eq()

bool UUID_eq	(	UUID	lhs,
		UUID	rhs )

Compare 2 UUID's.

Parameters

lhs	the left-hand side of the equality
rhs	the right-hand side of the equality

Returns

whether the 2 UUID's ar equal or not

UUID_serialize()

Buffer UUID_serialize

(

UUID

uuid

)

Serialize a UUID into a Buffer.

Caller must free memory in Buffer.buf.

Parameters

uuid	the UUID you want to serialize

Returns

the Buffer that the UUID represents