steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

msgpack: adding some docs.

db4
John Benediktsson 2013-10-14 11:44:40 -07:00
parent e2d4a1c3c8
commit 56412dc6f9
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
extra/msgpack/msgpack-docs.factor Normal file
View File

@ -0,0 +1,33 @@
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"