factor/extra/msgpack/msgpack-docs.factor

34 lines
917 B
Factor
Raw Normal View History

2013-10-14 14:44:40 -04:00
USING: help.markup help.syntax io kernel strings ;
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>
{ $values { "string" string } { "obj" object } }
{ $description "Decodes an object from the MessagePack format." } ;
HELP: >msgpack
{ $values { "obj" object } { "string" string } }
{ $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"