Description

OSSP UUID

Author

Kon Lovett

Version

Requires

Usage

(require-extension uuid-ossp)

Download

uuid-ossp.egg

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

Comparison Procedures

procedure: (uuid? UUID)

Is UUID a uuid?

procedure: (uuid-nil? UUID)

Is UUID the "nil" uuid?

procedure: (uuid= UUID1 UUID2)

Are UUID1 and UUID2 equal?

procedure: (uuid<> UUID1 UUID2)

Are UUID1 and UUID2 not equal?

procedure: (uuid< UUID1 UUID2)

Does UUID1 order below UUID2?

procedure: (uuid> UUID1 UUID2)

Does UUID1 order above UUID2?

procedure: (uuid<= UUID1 UUID2)

Does UUID1 order below or the same as UUID2?

procedure: (uuid>= UUID1 UUID2)

Does UUID1 order above or the same as UUID2?

Creation Procedures

procedure: (uuid-clone UUID)

Returns a copy of the UUID.

procedure: (uuid-load NAMESPACE)

Returns a uuid for the NAMESPACE.

procedure: (make-uuid [VARIANT [NAMESPACE NAME]])

Returns a uuid VARIANT, or the nil uuid when missing. The NAMESPACE and NAME are required for V3 and V5.

procedure: (uuid-import STRING)

Returns a uuid from the external STRING representation.

procedure: (uuid-import-binary BINARY-STRING)

Returns a uuid from the external BINARY-STRING representation.

Export Procedures

procedure: (uuid-export UUID)

Returns the external string representation of UUID.

procedure: (uuid-export-binary UUID)

Returns the external binary-string representation of UUID.

procedure: (uuid-export-text UUID)

Returns the external text representation of UUID.

Auxillary Procedures

procedure: (uuid-version)

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, the error message, and code, the error code.

Argument errors are signalled using error.

Issues

Requires at least release 1.3.0 of the OSSP UUID Library.

The use of the "uuid" prefix/name by the OSSP UUID Library is problematic. A generic name often with an existing meaning.

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.

Without the use of a build system which can deal with platform specific conditions installation of this egg might require manual intervention. The file "uuid-ossp-fix.c" has the references to the include file.

License

Copyright (c) 2006, Kon Lovett.  All rights reserved.

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.