Module uuid
ballerina/uuid
0.10.0-alpha8
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.
Functions
createType1AsRecord
Isolated Function
Returns a UUID of type 1 as a UUID record.
uuid:Uuid|uuid:Error uuid1 = uuid:createType1AsRecord();
createType1AsString
Isolated Function
function createType1AsString() returns stringReturns a UUID of type 1 as a string.
string uuid1 = uuid:createType1AsString();
Return Type
- string - UUID of type 1 as a string
createType3AsRecord
Isolated Function
function createType3AsRecord(NamespaceUUID namespace, string name) returns Uuid|ErrorReturns a UUID of type 3 as a UUID record.
uuid:Uuid|uuid:Error uuid3 = uuid:createType3AsRecord(uuid:NAME_SPACE_DNS, “ballerina.io”);
Parameters
- namespace NamespaceUUID - string representation for pre-defined namespace UUIDs
- name string - a name within the namespace
createType3AsString
Isolated Function
function createType3AsString(NamespaceUUID namespace, string name) returns string|ErrorReturns a UUID of type 3 as a string.
string|uuid:Error uuid3 = uuid:createType3AsString(uuid:NAME_SPACE_DNS, “ballerina.io”);
Parameters
- namespace NamespaceUUID - string representation for pre-defined namespace UUIDs
- name string - a name within the namespace
createType4AsRecord
Isolated Function
Returns a UUID of type 4 as a UUID record.
uuid:Uuid|uuid:Error uuid4 = uuid:createType4AsRecord();
createType4AsString
Isolated Function
function createType4AsString() returns stringReturns a UUID of type 4 as a string.
string uuid4 = uuid:createType4AsString();
Return Type
- string - UUID of type 4 as a string
createType5AsRecord
Isolated Function
function createType5AsRecord(NamespaceUUID namespace, string name) returns Uuid|ErrorReturns a UUID of type 5 as a UUID record.
uuid:Uuid|uuid:Error uuid5 = uuid:createType5AsRecord(uuid:NAME_SPACE_DNS, “ballerina.io”);
Parameters
- namespace NamespaceUUID - string representation for pre-defined namespace UUIDs
- name string - a name within the namespace
createType5AsString
Isolated Function
function createType5AsString(NamespaceUUID namespace, string name) returns string|ErrorReturns a UUID of type 5 as a string.
string|uuid:Error uuid5 = uuid:createType5AsString(uuid:NAME_SPACE_DNS, “ballerina.io”);
Parameters
- namespace NamespaceUUID - string representation for pre-defined namespace UUIDs
- name string - a name within the namespace
getVersion
Isolated Function
Detect RFC version of a UUID. Returns an error if the UUID is invalid.
uuid:Version|uuid:Error v = uuid:getVersion("4397465e-35f9-11eb-adc1-0242ac120002");
Parameters
- uuid string - UUID
nilAsRecord
Isolated Function
function nilAsRecord() returns UuidReturns a nil UUID as a UUID record.
uuid:Uuid nilUUID = uuid:nilAsRecord();
Return Type
- Uuid - nil UUID
nilAsString
Isolated Function
function nilAsString() returns stringReturns a nil UUID as a string.
string nilUUID = uuid:nilAsString();
Return Type
- string - nil UUID
toBytes
Isolated Function
Convert to an array of bytes. Returns an error if the UUID is invalid.
byte[]|uuid:Error b = uuid:toBytes(“6ec0bd7f-11c0-43da-975e-2aesass0b”);
Return Type
- byte[]|Error - UUID as bytes
toRecord
Isolated Function
Convert to UUID record. Returns error if the array is invalid.
uuid:Uuid|uuid:Error r1 = uuid:toRecord("4397465e-35f9-11eb-adc1-0242ac120002"); uuid:Uuid|uuid:Error r2 = uuid:toRecord([10, 20, 30]);
Parameters
- uuid string|byte[] - UUID to be converted
toString
Isolated Function
Convert to UUID string. Returns error if the array is invalid.
string|error s = uuid:toString([5, 12, 16, 35]);
Parameters
- uuid byte[]|Uuid - UUID to be converted
validate
Isolated Function
Test a string to see if it is a valid UUID.
boolean valid = uuid:validate("4397465e-35f9-11eb-adc1-0242ac120002");
Parameters
- uuid string - UUID to be tested
Return Type
- boolean - true if a valied UUID, false if not
Records
uuid: Uuid
Read Only
Represents a UUID.
Fields
- timeLow Unsigned32 - The low field of the timestamp
- timeMid Unsigned16 - The middle field of the timestamp
- timeHiAndVersion Unsigned16 - The high field of the timestamp multiplexed with the version number
- clockSeqHiAndReserved Unsigned8 - The high field of the clock sequence multiplexed with the variant
- clockSeqLo Unsigned8 - The low field of the clock sequence
- node int - The spatially unique node identifier
Enums
uuid: NamespaceUUID
Represents UUIDs strings of well known namespace IDs.
Members
NAME_SPACE_DNS - Namespace is a fully-qualified domain name
NAME_SPACE_URL - Namespace is a URL
NAME_SPACE_OID - Namespace is an ISO OID
NAME_SPACE_X500 - Namespace is an X.500 DN (in DER or a text output format)
NAME_SPACE_NIL - Empty UUID
uuid: Version
Represents the UUID versions.
Members
V1 - UUID generated using the MAC address of the computer and the time of generation
V3 - UUID generated using MD5 hashing and application-provided text string
V4 - UUID generated using a pseudo-random number generator
V5 - UUID generated using SHA-1 hashing and application-provided text string
Errors
uuid: Error
Represents UUID module related errors.