extra/bare/bare-docs.factor

   1 USING: byte-arrays help.markup help.syntax io kernel ;
   2
   3 IN: bare
   4
   5 HELP: read-bare
   6 { $values { "schema" "schema" } { "obj" object } }
   7 { $description "Decodes an object that was serialized in the BARE format using " { $snippet "schema" } ", reading from an " { $link input-stream } "." } ;
   8
   9 HELP: write-bare
  10 { $values { "obj" object } { "schema" "schema" } }
  11 { $description "Encodes an object into the BARE format using " { $snippet "schema" } ", writing to an " { $link output-stream } "." } ;
  12
  13 HELP: bare>
  14 { $values { "encoded" byte-array } { "schema" "schema" } { "obj" object } }
  15 { $description "Decodes an object that was serialized in the BARE format using " { $snippet "schema" } ", reading from a " { $link byte-array } "." } ;
  16
  17 HELP: >bare
  18 { $values { "obj" object } { "schema" "schema" } { "encoded" byte-array } }
  19 { $description "Encodes an object into the BARE format using " { $snippet "schema" } "." } ;
  20
  21 ARTICLE: "bare" "Binary Application Record Encoding (BARE)"
  22 "The Binary Application Record Encoding (BARE) is a draft format defined at "
  23 { $url "https://baremessages.org" } "."
  24 $nl
  25 "Decoding support for the BARE protocol:"
  26 { $subsections
  27     read-bare
  28     bare>
  29 }
  30 "Encoding support for the BARE protocol:"
  31 { $subsections
  32     write-bare
  33     >bare
  34 }
  35 "Using schema files:"
  36 { $subsections
  37     parse-schema
  38     load-schema
  39     \ SCHEMA:
  40 } ;
  41
  42 ABOUT: "bare"