basis/cbor/cbor-docs.factor

   1 USING: byte-arrays help.markup help.syntax io kernel sequences strings ;
   2
   3 IN: cbor
   4
   5 HELP: read-cbor
   6 { $values { "obj" object } }
   7 { $description "Decodes an object that was serialized in the CBOR format, reading from an " { $link input-stream } "." } ;
   8
   9 HELP: write-cbor
  10 { $values { "obj" object } }
  11 { $description "Encodes an object into the CBOR format, writing to an " { $link output-stream } "." } ;
  12
  13 HELP: cbor>
  14 { $values { "seq" sequence } { "obj" object } }
  15 { $description "Decodes an object from the CBOR format, represented as a " { $link byte-array } " or " { $link string } "." } ;
  16
  17 HELP: >cbor
  18 { $values { "obj" object } { "bytes" byte-array } }
  19 { $description "Encodes an object into the CBOR format." } ;
  20
  21 ARTICLE: "cbor" "Concise Binary Object Representation (CBOR)"
  22 "The Concise Binary Object Representation (CBOR) is defined in RFC 7049."
  23 $nl
  24 "Decoding support for the CBOR protocol:"
  25 { $subsections
  26     read-cbor
  27     cbor>
  28 }
  29 "Encoding support for the CBOR protocol:"
  30 { $subsections
  31     write-cbor
  32     >cbor
  33 } ;
  34
  35 ABOUT: "cbor"