basis/uuid/uuid-docs.factor

   1
   2 USING: help.syntax help.markup kernel prettyprint sequences strings ;
   3
   4 IN: uuid
   5
   6 HELP: uuid1
   7 { $description
   8     "Generates a UUID (version 1) from the host ID, sequence number, "
   9     "and current time."
  10 } ;
  11
  12 HELP: uuid3
  13 { $description
  14     "Generates a UUID (version 3) from the MD5 hash of a namespace "
  15     "UUID and a name."
  16 } ;
  17
  18 HELP: uuid4
  19 { $description
  20     "Generates a UUID (version 4) from random bits."
  21 } ;
  22
  23 HELP: uuid5
  24 { $description
  25     "Generates a UUID (version 5) from the SHA-1 hash of a namespace "
  26     "UUID and a name."
  27 } ;
  28
  29
  30 ARTICLE: "uuid" "UUID (Universally Unique Identifier)"
  31 "The " { $vocab-link "uuid" } " vocabulary is used to generate UUID's. "
  32 "The words uuid1, uuid3, uuid4, uuid5 can be used to generate version "
  33 "1, 3, 4, and 5 UUIDs as specified in RFC 4122.\n"
  34 "\n"
  35 "If all you want is a unique ID, you should probably call uuid1 or uuid4."
  36 "\n"
  37 { $subsection uuid1 }
  38 { $subsection uuid3 }
  39 { $subsection uuid4 }
  40 { $subsection uuid5 }
  41 ;
  42
  43 ABOUT: "uuid"
  44
  45