basis/msgpack/msgpack-docs.factor

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