factor/extra/msgpack/msgpack-docs.factor

34 lines
1008 B
Factor
Raw Normal View History

2013-11-27 20:36:38 -05:00
USING: byte-arrays help.markup help.syntax io kernel sequences strings ;
2013-10-14 14:44:40 -04:00
IN: msgpack
HELP: read-msgpack
{ $values { "obj" object } }
{ $description "Decodes an object that was serialized in the MessagePack format, reading from an " { $link input-stream } "." } ;
HELP: write-msgpack
{ $values { "obj" object } }
{ $description "Encodes an object into the MessagePack format, writing to an " { $link output-stream } "." } ;
HELP: msgpack>
2013-11-27 20:36:38 -05:00
{ $values { "seq" sequence } { "obj" object } }
{ $description "Decodes an object from the MessagePack format, represented as a " { $link byte-array } " or " { $link string } "." } ;
2013-10-14 14:44:40 -04:00
HELP: >msgpack
2013-11-27 20:36:38 -05:00
{ $values { "obj" object } { "bytes" byte-array } }
2013-10-14 14:44:40 -04:00
{ $description "Encodes an object into the MessagePack format." } ;
ARTICLE: "msgpack" "MessagePack"
"Decoding support for the MessagePack protocol:"
{ $subsections
read-msgpack
msgpack>
}
"Encoding support for the MessagePack protocol:"
{ $subsections
write-msgpack
>msgpack
} ;
ABOUT: "msgpack"