uuid-ossp | chickadee

Documentation

Provides access to the OSSP UUID Library. This document does not supplant the OSSP UUID Library documentation.

The OSSP UUID Library is not included in this distribution. The library source is available at the above URL. See the Issues section below for more information.

Pre-defined Namespaces

"nil": 00000000-0000-0000-0000-000000000000
"ns: DNS" : 6ba7b810-9dad-11d1-80b4-00c04fd430c8
"ns: URL" : 6ba7b811-9dad-11d1-80b4-00c04fd430c8
"ns: OID" : 6ba7b812-9dad-11d1-80b4-00c04fd430c8
"ns: X500" : 6ba7b814-9dad-11d1-80b4-00c04fd430c8

UUID Variants

V1: DCE 1.1 variant UUID of version 1
V1-MC: DCE 1.1 variant UUID of version 1 with random MAC address
V3: DCE 1.1 variant UUID of version 3
V4: DCE 1.1 variant UUID of version 4
V5: DCE 1.1 variant UUID of version 5

Predicates

uuid?

(uuid? UUID) => boolean procedure: Is UUID a uuid?

uuid-nil?

(uuid-null? UUID) => boolean procedure
(uuid-nil? UUID) => boolean procedure: Is UUID the nil-uuid?

uuid-compare

(uuid-compare UUID1 UUID2) => integer procedure: Returns the comparison of UUID1 and UUID2 as -1, 0, or 1.

uuid=?

(uuid=? UUID1 UUID2) => boolean procedure: Are UUID1 and UUID2 equal?

uuid<?

(uuid<? UUID1 UUID2) => boolean procedure: Does UUID1 order below UUID2?

uuid>?

(uuid>? UUID1 UUID2) => boolean procedure: Does UUID1 order above UUID2?

uuid<=?

(uuid<=? UUID1 UUID2) => boolean procedure: Does UUID1 order below or the same as UUID2?

uuid>=?

(uuid>=? UUID1 UUID2) => boolean procedure: Does UUID1 order above or the same as UUID2?

Operations

uuid-clear!

(uuid-clear! UUID) => uuid procedure: Overwrites the existing UUID with the nil-uuid.

uuid-clone

(uuid-copy UUID) => uuid procedure
(uuid-clone UUID) => uuid procedure: Returns a copy of the UUID.

make-uuid

(make-uuid [VARIANT [NAMESPACE NAME]]) => uuid procedure

Returns a uuid VARIANT, or the nil-uuid when missing.

The NAMESPACE and NAME are required for V3 and V5 variants.

VARIANT, NAMESPACE, NAME are string.

The symbols time and random are synonyms for V1 and V4, respectively.

string->uuid

(string->uuid STRING) => uuid procedure: Returns a new uuid from the external STRING representation.

uuid->string

(uuid->string UUID) => string procedure: Returns the external string representation of UUID.

uuid-load!

(uuid-load! UUID [NAMESPACE]) => uuid procedure

Overwrites the existing UUID with the NAMESPACE indicated uuid. When missing "nil" is assumed.

NAMESPACE is a string.

uuid-load

(uuid-load [NAMESPACE]) => uuid procedure

Returns a new uuid with the NAMESPACE uuid. When missing "nil" is assumed.

NAMESPACE is a string.

uuid-import

(uuid-import STRING) => uuid procedure: Returns a uuid from the external STRING representation.

uuid-import-binary

(uuid-import-binary STRING) => uuid procedure: Returns a uuid from the external STRING binary representation.

uuid-import-siv

(uuid-import-siv STRING) => uuid procedure: Returns a uuid from the external STRING single integer value representation.

uuid-export

(uuid-export UUID) => string procedure: Returns the external string representation of UUID.

uuid-export-binary

(uuid-export-binary UUID) => procedure: Returns the external binary-string representation of UUID.

uuid-export-text

(uuid-export-text UUID) => string procedure: Returns the external text representation of UUID.

uuid-export-siv

(uuid-export-siv UUID) => string procedure: Returns the external single integer value representation of UUID.

Auxillary Procedures

uuid-version

(uuid-version) => integer procedure: Returns OSSP UUID Library version as an unsigned-long.

Errors

Errors generated by the OSSP UUID Library are signalled using a condition of (exn uuid), with properties message, and code.

Argument errors are signalled using error.

Usage

(require-extension uuid-ossp)

Notes

The uuid?. uuid-null?, uuid-compare, uuid=?, uuid<?, uuid>?, uuid<=?, uuid>=?, make-uuid, uuid-copy, uuid-clear!, string->uuid, uuid->string share the same signature as the corresponding routines in the uuid-lib extension.
Requires at least release 1.5.0 of the OSSP uuid Library.
Installation of this egg might require manual intervention. Please see the uuid-ossp-fix.[ch] files which isolate the system header confilicts caused by the OSSP uuid.h header.
The build uses the uuid-config tool to locate the proper include directory.
Reed Sheridan has pointed out that the Debian system renames the library, as an existing library of the same name already exists. For example, uuid.h is ossp/uuid.h.

Version history

1.4.0: Added uuid-copy, uuid-clear!, string->uuid, uuid->string, uuid-import-siv, uuid-export-siv, uuid-load!. Deprecated uuid<>?. Dropped uuid=, etc.
1.3.0: Deprecated uuid=, etc.
1.22: Hello

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

chickadee » uuid-ossp

Identifier search

TOC »

Contents »