Functions
createType1AsRecord | I Returns a UUID of type 1 as a UUID record. |
createType1AsString | I Returns a UUID of type 1 as a string. |
createType3AsRecord | I Returns a UUID of type 3 as a UUID record. |
createType3AsString | I Returns a UUID of type 3 as a string. |
createType4AsRecord | I Returns a UUID of type 4 as a UUID record. |
createType4AsString | I Returns a UUID of type 4 as a string. |
createType5AsRecord | I Returns a UUID of type 5 as a UUID record. |
createType5AsString | I Returns a UUID of type 5 as a string. |
getVersion | I Detect RFC version of a UUID. |
nilAsRecord | I Returns a nil UUID as a UUID record. |
nilAsString | I Returns a nil UUID as a string. |
toBytes | I Converts to an array of bytes. |
toRecord | I Converts to a UUID record. |
toString | I Converts to a UUID string. |
validate | I Test a string to see if it is a valid UUID. |
createType1AsRecord
Returns a UUID of type 1 as a UUID record.
1uuid:Uuid uuid1 = check uuid:createType1AsRecord();
createType1AsString
function createType1AsString() returns string
Returns a UUID of type 1 as a string.
1string uuid1 = uuid:createType1AsString();
createType3AsRecord
function createType3AsRecord(NamespaceUUID namespace, string name) returns Uuid | Error
Returns a UUID of type 3 as a UUID record.
1uuid:Uuid uuid3 = check uuid:createType3AsRecord(uuid:NAME_SPACE_DNS, “ballerina.io”);
Parameters
- namespace NamespaceUUID
String representation for a pre-defined namespace UUID
- name string
A name within the namespace
createType3AsString
function createType3AsString(NamespaceUUID namespace, string name) returns string | Error
Returns a UUID of type 3 as a string.
1string uuid3 = check uuid:createType3AsString(uuid:NAME_SPACE_DNS, “ballerina.io”);
Parameters
- namespace NamespaceUUID
String representation for a pre-defined namespace UUID
- name string
A name within the namespace
createType4AsRecord
Returns a UUID of type 4 as a UUID record.
1uuid:Uuid uuid4 = check uuid:createType4AsRecord();
createType4AsString
function createType4AsString() returns string
Returns a UUID of type 4 as a string.
1string uuid4 = uuid:createType4AsString();
createType5AsRecord
function createType5AsRecord(NamespaceUUID namespace, string name) returns Uuid | Error
Returns a UUID of type 5 as a UUID record.
1uuid:Uuid uuid5 = check uuid:createType5AsRecord(uuid:NAME_SPACE_DNS, “ballerina.io”);
Parameters
- namespace NamespaceUUID
String representation for a pre-defined namespace UUID
- name string
A name within the namespace
createType5AsString
function createType5AsString(NamespaceUUID namespace, string name) returns string | Error
Returns a UUID of type 5 as a string.
1string uuid5 = check uuid:createType5AsString(uuid:NAME_SPACE_DNS, “ballerina.io”);
Parameters
- namespace NamespaceUUID
String representation for a pre-defined namespace UUID
- name string
A name within the namespace
getVersion
Detect RFC version of a UUID. Returns an error if the UUID is invalid.
1uuid:Version v = check uuid:getVersion("4397465e-35f9-11eb-adc1-0242ac120002");
Parameters
- uuid string
UUID string to be checked
nilAsRecord
function nilAsRecord() returns Uuid
Returns a nil UUID as a UUID record.
1uuid:Uuid nilUUID = uuid:nilAsRecord();
nilAsString
function nilAsString() returns string
Returns a nil UUID as a string.
1string nilUUID = uuid:nilAsString();
toBytes
Converts to an array of bytes. Returns an error if the UUID is invalid.
1byte[] b = check uuid:toBytes(“6ec0bd7f-11c0-43da-975e-2aesass0b”);
toRecord
Converts to a UUID record. Returns an error if the UUID is invalid.
1uuid:Uuid r1 = check uuid:toRecord("4397465e-35f9-11eb-adc1-0242ac120002");2uuid:Uuid r2 = check uuid:toRecord([10, 20, 30]);
Parameters
- uuid string | byte[ ]
UUID to be converted
toString
Converts to a UUID string. Returns an error if the UUID is invalid.
1string s = check uuid:toString([5, 12, 16, 35]);
Parameters
- uuid byte[ ] | Uuid
UUID to be converted