uuid-lib

OSF DCE 1.1 UUID

  1. uuid-lib
  2. Documentation
    1. Operations
      1. make-uuid
      2. uuid-generate
      3. uuid-clear!
      4. uuid-copy
      5. string->uuid
      6. uuid->string
      7. uuid-parse
      8. uuid-unparse
    2. Predicates
      1. uuid?
      2. uuid-null?
      3. uuid-compare
      4. uuid=?
      5. uuid<?
      6. uuid>?
      7. uuid<=?
      8. uuid>=?
      9. uuid-hash
  3. Version & Method
    1. uuid-version?
    2. uuid-version->method
    3. uuid-method->version
    4. uuid-method
    5. uuid-version-number
    6. check-uuid
  4. Checks & Errors
    1. check-uuid
    2. error-uuid
    3. check-uuid-version
    4. error-uuid-version
  5. Usage
  6. Notes
  7. Requirements
  8. Author
  9. Version history
  10. License

Documentation

Wrapper for uuid/uuid.h procedures on macOS X, and Linux.

Operations

make-uuid

[procedure] (make-uuid [METHOD]) -> uuid

Returns a new uuid, as uuid-generate, or a null-uuid as the default.

uuid-generate

[procedure] (uuid-generate [METHOD]) -> uuid

Returns a new uuid made using the stated METHOD.

METHOD
(or false symbol) ; the UUID Version
'v1, 'V1, or 'time
DCE Version 1 (MAC address) algorithm.
'v4, 'V4, or 'random
DCE Version 4 (random) algorithm.
#f
DCE V4 if a high-quality random device available, otherwise DCE V1. The default.

An invalid METHOD is an error condition.

uuid-clear!

[procedure] (uuid-clear! UUID) -> uuid

Returns the UUID set to the null-uuid.

uuid-copy

[procedure] (uuid-copy UUID) -> uuid

Returns a copy of the UUID.

string->uuid

[procedure] (string->uuid UUID-STRING) -> uuid

Returns a new uuid from the external string representation UUID-STRING.

uuid->string

[procedure] (uuid->string UUID) -> string

Returns the external string representation of UUID.

uuid-parse

[procedure] (uuid-parse UUID-TEXT) -> uuid

Returns a new uuid from the external string representation UUID-TEXT.

uuid-unparse

[procedure] (uuid-unparse UUID [CASE]) -> string

Returns the external string representation of UUID.

CASE
(or false symbol) ; 'upper, 'lower, or #f. Default is #f.

An invalid CASE is an error condition.

Predicates

uuid?

[procedure] (uuid? UUID) -> boolean

Is UUID a uuid?

uuid-null?

[procedure] (uuid-null? UUID) -> boolean

Is UUID the null uuid?

uuid-compare

[procedure] (uuid-compare UUID1 UUID2) -> fixnum

Returns -1, 0. or 1 for the comparison of UUID1 and UUID2.

uuid=?

uuid<?

uuid>?

uuid<=?

uuid>=?

[procedure] (uuid=? UUID1 UUID2) -> boolean
[procedure] (uuid<? UUID1 UUID2) -> boolean
[procedure] (uuid>? UUID1 UUID2) -> boolean
[procedure] (uuid<=? UUID1 UUID2) -> boolean
[procedure] (uuid>=? UUID1 UUID2) -> boolean

uuid-compare wrappers.

uuid-hash

[procedure] (uuid-hash UUID [BOUND [RANDOMIZATION]]) -> fixnum

Returns a hash of the UUID, modulo the BOUND, & the RANDOMIZATION.

A srfi-69 compatible, version specific, hash function.

Version & Method
uuid-version : {{(or false fixnum)
uuid-method : {{(or false symbol)

uuid-version?

[procedure] (uuid-version? OBJ) -> boolean

Is the OBJ a uuid-version?

uuid-version->method

[procedure] (uuid-version->method VERSION) -> uuid-method

An invalid VERSION is an error condition.

uuid-method->version

[procedure] (uuid-method->version METHOD) -> uuid-version

An invalid METHOD is an error condition.

uuid-method

[procedure] (uuid-method UUID) -> uuid-method

uuid-version-number

[procedure] (uuid-version-number UUID) -> fixnum

Returns UUID version-number, 0 .. 15.

Note that uuid-version-number is not reliable cross-platform; 'linux' for example.

check-uuid

[procedure] (uuid-print UUID [PORT]) -> boolean

Checks & Errors

check-uuid

error-uuid

[procedure] (check-uuid LOC OBJ [ARGNAM]) -> uuid
[procedure] (error-uuid LOC OBJ [ARGNAM])) -> void

check-uuid-version

error-uuid-version

[procedure] (check-uuid-version LOC OBJ [ARGNAM])) -> uuid-version
[procedure] (error-uuid-version LOC * [ARGNAM])) -> void

Usage

 
(import uuid-lib)

Notes

Requirements

record-variants

test test-utils

Author

Kon Lovett

Version history
0.0.8
Add uuid-version-number.
0.0.6
.
0.0.6
variant => method.
0.0.5
Fix uuid-parse uuid method.
0.0.4
(srfi 69) compatible hashers.
0.0.3
Add uuid-hash uuid-v4-hash, & uuid-print. Add record printer.
0.0.2
.
0.0.1
C5 port of C4 1.5.0 (need Linux testing).

License

Copyright (C) 2010-2023 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.