basis/uuid/uuid-docs.factor

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