Add compress and uncompress utility methods (#9)

* Add compress and decompress utility methods - Add basic constants of zlib. - Add conditions to replace numeric code errors. - Add the utility methods 'zlib-compress' and 'zlib-uncompress'. - Use 'compress2' binding method of zlib to pass compression level. - Add basic test of compress/decompress. - Use <byte-vector> instead of <string> for compress/uncompress Thanks to the comments of @waywardmonkeys * doc: Document library Thanks to the comments of @cgay
dylan-lang · Oct 29, 2024 · 6fc73c9 · 6fc73c9
1 parent 567f514
commit 6fc73c9
Show file tree

Hide file tree

Showing 11 changed files with 906 additions and 73 deletions.
diff --git a/documentation/source/index.rst b/documentation/source/index.rst
@@ -1,15 +1,25 @@
-Welcome to Zlib's documentation!
-================================
+zlib
+====
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
    :hidden:
 
-   reference
+   zlib
+   zlib-binding
 
-This is the beginning of a binding to the `Zlib
-<https://www.zlib.net/>`_ library.
+This is the binding to the `Zlib <https://www.zlib.net/>`_ library
+version ``1.3.1``.
+
+The library is structured in two layers of modules:
+
+* The module :doc:`zlib-binding` is the direct binding of the zlib
+  library, making the C language functions and constants accessible to
+  Open Dylan.
+
+* The module :doc:`zlib` sits on top of :doc:`zlib-binding` and offers a
+  more idiomatic access to the functionality.
 
 Indices and tables
 ==================

diff --git a/documentation/source/reference.rst b/documentation/source/reference.rst