Changeset 39759 in project

Timestamp:

03/26/21 19:43:09 (4 weeks ago)

Author:

svnwiki

Message:

Anonymous wiki edit for IP [77.201.196.48]: Use the procedure tag, fix formatting

File:

• wiki/eggref/5/msgpack (modified) (8 diffs)

wiki/eggref/5/msgpack

@@ -1 @@
-
 == msgpack
 [[toc:]]
@@ -5 +4 @@
 
 Forked from [[http://github.com/hugoArregui/msgpack-scheme|msgpack-scheme]] and partially rewritten
-(ported to CHICKEN 5 and cleaned up).
-I kept the original license and most of the original API. However the byte-blob have been replaced with
+(ported to CHICKEN 5 and built-in byte blob API).
+I kept the original license and most of the original API. However, the byte-blob have been replaced with
 Chicken 5 native blob.
 I removed the dependency on bind egg and the need for C++ code using built-ins features of C5.
@@ -13 +12 @@
 === Authors
 Hugo Arregui: Original author of the egg.
+
 Théo Cavignac: ported the egg to Chicken 5
 
@@ -22 +22 @@
 === Requirements
 This package requires the following eggs:
-- matchable
-- srfi-1
-- srfi-69
+
+* matchable
+* srfi-1
+* srfi-69
 
 
@@ -32 +33 @@
 
 From source:
-First install the required eggs listed above.
-Then clone this [[https://github.com/Lattay/chicken-msgpack|repository]].
-Finally run {{chicken-install -s}} in the root of this repository.
+
+# Install the required eggs listed above.
+# Clone this [[https://github.com/Lattay/chicken-msgpack|repository]].
+# Run {{chicken-install -s}} in the root of this repository.
 
 
@@ -40 +42 @@
 Primitive pack-family procedures:
 
-<enscript highlight="scheme"> 
-(pack-uint port value)     ; will produce an error if the input is negative
-(pack-sint port value)
-(pack-float port FLONUM)   ; pack 32b floats, support both exact and inexact but convert to flonum (inexact) anyway
-(pack-double port FLONUM)  ; pack 64b floats, same limitations as above
-(pack-bin port BLOB)       ; chicken.blob byte blob
-(pack-str port STRING)     ; string
-(pack-array port VECTOR)   ; scheme vector, also support lists
-(pack-map port HASH-TABLE) ; srfi-69 hash-table
-(pack-ext port EXT)        ; extension (see below)
-</enscript>
+<procedure>(pack-uint port value)</procedure>
+<procedure>(pack-sint port value)</procedure>
+pack integer, will produce an error if the input does not respect the expected signedness
 
-Also the simplest way to use is to use the generic procedures:
+<procedure>(pack-float port FLONUM)</procedure>
+pack 32b floats, support both exact and inexact but convert to flonum (inexact) anyway
 
-<enscript highlight="scheme"> 
-(pack port value)
-(pack/blob value)
-</enscript>
+<procedure>(pack-double port FLONUM)</procedure>
+pack 64b floats, support both exact and inexact but convert to flonum (inexact) anyway
+
+<procedure>(pack-bin port BLOB)</procedure>
+pack chicken.blob byte blob
+
+<procedure>(pack-str port STRING)</procedure>
+pack string
+
+<procedure>(pack-array port VECTOR)</procedure>
+pack scheme vectors or lists
+
+<procedure>(pack-map port HASH-TABLE)</procedure>
+pack srfi-69 hash-table
+
+<procedure>(pack-ext port EXT)</procedure>
+pack extension record (see below)
+
+Automatic procedures:
+
+<procedure>(pack port value)</procedure>
+Will infer the right packer to use and write the msgpack result to port
+
+<procedure>(pack/blob value)</procedure>
+Will inter the right packer and return the message as a byte blob
 
 These procedures will call primitive type packers, with the following rules:
-- if the value has a packer, apply it.
-- if the value is a string, it will be packed as str.
-- if the value is a blob, it will be packed as bin.
-- if the value is a char, it will be packed as a uint.
-- if the value is a list, it will be packed as an array.
-- if the value is a extension (see below), it will be packed as an ext
+
+* if the value has a packer, apply it.
+* if the value is a string, it will be packed as str.
+* if the value is a blob, it will be packed as bin.
+* if the value is a char, it will be packed as a uint.
+* if the value is a list, it will be packed as an array.
+* if the value is a extension (see below), it will be packed as an ext
 
 The {{/blob}} version return a blob of packed data, the others directly write it to the port.
 
 Unpack procedures:
-    [lang:scheme]
+<procedure>(unpack port [mapper])</procedure>
+Read msgpack data from port and return the unpacked data.
 
- (unpack port [mapper])
- (unpack/blob blob [mapper])
+<procedure>(unpack/blob blob [mapper])</procedure>
+Treat the blob as a msgpack data and return the unpacked data.
 
 The optional mapper argument is applied to the output before returning.
@@ -82 +100 @@
 Extension is a record defined as:
 
-{{
-(define-record extension type data)
-}}
+<enscript highlight="scheme">(define-record extension type data)</enscript>
 
 * type: integer from 0 to 127
 * data: a blob
 
-Example:
+Use-case example:
 
-<enscript highlight="scheme"> 
-(make-extension 10 (string->byte-blob "hi"))
-</enscript>
+<enscript highlight="scheme">(make-extension 10 (string->byte-blob "hi"))</enscript>
 
 
@@ -101 +115 @@
 
 === History
-v1.0.3 Ironing details for publication.
 
-v1.0.0 Port to Chicken 5.
+* v1.0.3 Ironing details for publication.
+
+* v1.0.0 Port to Chicken 5.
 Breaking changes:
 All blob related APIs have been changed to support Chicken native blob type.
 
-v0.4 Last Chicken 4 version (2016)
+* v0.4 Last Chicken 4 version (2016)