<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Falcon Feathers - The Standard Modules Reference.</title> <link href="faldoc.css" rel="stylesheet" type="text/css"/> <link href="tabs.css" rel="stylesheet" type="text/css"/> </head> <body class="faldoc_body"> <div class="navitop"> <div class="tabs"> <ul> <li><a href="./index.html"><span>Main</span></a></li> <li><a href="./modules.html"><span>Modules</span></a></li> <li><a href="./pages.html"><span>Related pages</span></a></li> <li><a href="./groups.html"><span>Groups</span></a></li> <li><a href="./classes.html"><span>Classes</span></a></li> <li><a href="./objects.html"><span>Objects</span></a></li> <li><a href="./functions.html"><span>All functions</span></a></li> <li><a href="./enum.html"><span>Enumerations</span></a></li> </ul> </div> </div> <hr/> <h1 class="faldoc_title">Module ZLib </h1> <p class="faldoc_brief">Compress/uncompress functions (zlib binding). </p> <p class="faldoc_text"><p class="faldoc_text">This module provides an essential interface to the Zlib compression routines. </p> <p class="faldoc_text"> The greatest part of the functionalites of the module are encapsulated in the <a href="./class_ZLib.html">ZLib</a> class, which provided some class-wide methods to compress and uncompress data. </p> <p class="faldoc_text">The following example can be considered a minimal usage pattern: </p> <pre class="faldoc_code"> load zlib original = "Mary had a little lamb, it's fleece was white as snow." > "Uncompressed: ", original comped = ZLib.compressText( original ) > "Compressed then uncompressed:" > " ", ZLib.uncompressText( comped ) </pre> <p class="faldoc_text"> The module declares also a <b>ZLibError</b> that is raised in case of failure in compression/decompression operations. </p> </p> <h2 class="faldoc_title">Classes</h2> <table class="faldoc_list"> <tr><td class="faldoc_funcname"><a href="./class_ZLib.html">ZLib</a></td><td class="faldoc_funcbrief">ZLib encapsulation interface. </td></tr> <tr><td class="faldoc_funcname"><a href="./class_ZLibError.html">ZLibError</a></td><td class="faldoc_funcbrief">Error generated by errors in the ZLib module. </td></tr> </table> <h2 class="faldoc_title">Enumerations</h2> <table class="faldoc_list"> <tr><td class="faldoc_funcname"><a href="./enum_ZLibErrorCode.html">ZLibErrorCode</a></td><td class="faldoc_funcbrief">Error codes generated by ZLib methods. </td></tr> </table> <hr/> <div class="navibottom"> <center> <a href="./index.html">Main</a> - <a href="./modules.html">Modules</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./enum.html">Enumerations</a> </center> </div> </div> <div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div> </body> </html>