## Package overview

This package provides functions related to UUID (Universally unique identifier). For an example on the usage of the operations, see the [UUID Example](https://ballerina.io/learn/by-example/uuid.html).


Represents UUIDs strings of well known namespace IDs.



Namespace is a fully-qualified domain name


NAME_SPACE_DNS

NAME_SPACE_URL

NAME_SPACE_OID

Namespace is an X.500 DN (in DER or a text output format)


NAME_SPACE_X500

NAME_SPACE_NIL

NamespaceUUID

UUID generated using the MAC address of the computer and the time of generation


UUID generated using MD5 hashing and application-provided text string


UUID generated using a pseudo-random number generator


UUID generated using SHA-1 hashing and application-provided text string


Version

Error

Returns a UUID of type 1 as a UUID record.
```ballerina
uuid:Uuid|uuid:Error uuid1 = uuid:createType1AsRecord();
```



createType1AsRecord

UUID of type 1 as a UUID record or error


Uuid

Returns a UUID of type 1 as a string.
```ballerina
string uuid1 = uuid:createType1AsString();
```



createType1AsString

string

Returns a UUID of type 3 as a UUID record.
```ballerina
uuid:Uuid|uuid:Error uuid3 = uuid:createType3AsRecord(uuid:NAME_SPACE_DNS, “ballerina.io”);
```



createType3AsRecord

string representation for pre-defined namespace UUIDs


namespace

name

UUID of type 3 as a UUID record or error


Returns a UUID of type 3 as a string.
```ballerina
string|uuid:Error uuid3 = uuid:createType3AsString(uuid:NAME_SPACE_DNS, “ballerina.io”);
```



createType3AsString

Returns a UUID of type 4 as a UUID record.
```ballerina
uuid:Uuid|uuid:Error uuid4 = uuid:createType4AsRecord();
```



createType4AsRecord

UUID of type 4 as a UUID record or error


Returns a UUID of type 4 as a string.
```ballerina
string uuid4 = uuid:createType4AsString();
```



createType4AsString

Returns a UUID of type 5 as a UUID record.
```ballerina
uuid:Uuid|uuid:Error uuid5 = uuid:createType5AsRecord(uuid:NAME_SPACE_DNS, “ballerina.io”);
```



createType5AsRecord

UUID of type 5 as a UUID record or error


Returns a UUID of type 5 as a string.
```ballerina
string|uuid:Error uuid5 = uuid:createType5AsString(uuid:NAME_SPACE_DNS, “ballerina.io”);
```



createType5AsString

Detect RFC version of a UUID. Returns an error if the UUID is invalid.
```ballerina
uuid:Version|uuid:Error v = uuid:getVersion("4397465e-35f9-11eb-adc1-0242ac120002");
```



getVersion

uuid

Returns a nil UUID as a UUID record.
```ballerina
uuid:Uuid nilUUID = uuid:nilAsRecord();
```



nilAsRecord

Returns a nil UUID as a string.
```ballerina
string nilUUID = uuid:nilAsString();
```



nilAsString

Convert to an array of bytes. Returns an error if the UUID is invalid.
```ballerina
byte[]|uuid:Error b = uuid:toBytes(“6ec0bd7f-11c0-43da-975e-2aesass0b”);
```



toBytes

Convert to UUID record. Returns error if the array is invalid.
```ballerina
uuid:Uuid|uuid:Error r1 = uuid:toRecord("4397465e-35f9-11eb-adc1-0242ac120002");
uuid:Uuid|uuid:Error r2 = uuid:toRecord([10, 20, 30]);
```



toRecord

Convert to UUID string. Returns error if the array is invalid.
```ballerina
string|error s = uuid:toString([5, 12, 16, 35]);
```



toString

error

Test a string to see if it is a valid UUID.
```ballerina
boolean valid = uuid:validate("4397465e-35f9-11eb-adc1-0242ac120002");
```



validate

boolean

timeLow

Unsigned32

timeMid

Unsigned16

The high field of the timestamp multiplexed with the version number


timeHiAndVersion

The high field of the clock sequence multiplexed with the variant


clockSeqHiAndReserved

Unsigned8

clockSeqLo

node

This package provides functions related to UUID (Universally unique identifier). For an example on the usage of the operations, see the "UUID Example" (https://ballerina.io/learn/by-example/uuid.html).

Represents UUIDs strings of well known namespace IDs.

Returns a UUID of type 1 as a UUID record.

Returns a UUID of type 3 as a UUID record.

Returns a UUID of type 4 as a UUID record.

Returns a UUID of type 5 as a UUID record.

Test a string to see if it is a valid UUID.

This package provides functions related to UUID (Universally unique identifier).

ballerina/uuid
0.10.0-alpha8
1.0.0 0.10.0-beta.2 0.10.0-beta.1 0.10.0-alpha8

Package overview

Functions

Records

Enums

Errors