<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Class ZLib - Class ZLib</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">Class ZLib<span class="faldoc_belong"><a href="./module_feather_zlib.html">[in ZLib]</a></p></h1>
<p class="faldoc_brief">ZLib encapsulation interface. </p>
<p class="faldoc_funcdecl">
<b>class</b> ZLib
</p>
<p class="faldoc_brief"><a href="#more">more...</a></p>
<h2 class="faldoc_title">Summary</h2>
<table class="faldoc_list">
<tr><td><a href="#compress">compress()</a></td><td>Compress a buffer (classwide method). </td></tr>
<tr><td><a href="#compressText">compressText()</a></td><td>Compress a text string (classwide method). </td></tr>
<tr><td><a href="#uncompress">uncompress()</a></td><td>Uncompress a buffer (classwide method). </td></tr>
<tr><td><a href="#uncompressText">uncompressText()</a></td><td>Uncompress a buffer into a text (classwide method). </td></tr>
</table>
<a name="more"><h2 class="faldoc_title">Detailed description</h2></a>
<p class="faldoc_funcdecl">
<b>class</b> ZLib
</p>
<table class="faldoc_function">
</table>
<br/>
<p class="item_brief">ZLib encapsulation interface. </p>
<p class="faldoc_text">Actually, this is a encapsulation class which is used to insolate ZLib functions. Methods in this encapsulation are class-static methods of the ZLib class, and it is not necessary to create an instance of this class to use its methods. </p>
<h2 class="faldoc_title">Methods</h2>
<h3 class="faldoc_funcname"><a name="compress">compress()</a></h3>
<p class="item_brief">Compress a buffer (classwide method). </p>
<p class="faldoc_funcdecl">ZLib.compress( buffer )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">buffer</td><td class="faldoc_paramdesc">A string or a MemBuf to be compressed. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A compressed buffer (in a byte-wide MemBuf). </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_ZLibError.html">ZLibError</a></td><td class="faldoc_raisedesc">on compression error. </td></tr>
</table>
</td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">This method will compress the data considering its raw memory value. This is suitable for bytewise strings loaded from binary streams and byte-wide memory buffers. </p>
<p class="faldoc_text">Strings containing multi-byte characters can be compressed through this method, but the decompression process must know their original size and perform an adequate trancoding. </p>
<p class="faldoc_text"> For text strings, it is preferrable to use the <a href="./class_ZLib.html#compressText">ZLib.compressText</a> function. </p>
</p>
<h3 class="faldoc_funcname"><a name="compressText">compressText()</a></h3>
<p class="item_brief">Compress a text string (classwide method). </p>
<p class="faldoc_funcdecl">ZLib.compressText( text )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">text</td><td class="faldoc_paramdesc">A string containing a text be compressed. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A compressed buffer (in a byte-wide MemBuf). </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_ZLibError.html">ZLibError</a></td><td class="faldoc_raisedesc">on compression error. </td></tr>
</table>
</td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text"> This method will compress the a text so that an <a href="./class_ZLib.html#uncompressText">ZLib.uncompressText</a> re-creates the original string. </p>
</p>
<h3 class="faldoc_funcname"><a name="uncompress">uncompress()</a></h3>
<p class="item_brief">Uncompress a buffer (classwide method). </p>
<p class="faldoc_funcdecl">ZLib.uncompress( buffer )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">buffer</td><td class="faldoc_paramdesc">A string or MemBuf containing previusly compressed data. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A MemBuf containing the uncompressed data. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_ZLibError.html">ZLibError</a></td><td class="faldoc_raisedesc">on decompression error. </td></tr>
</table>
</td></tr>
</table>
<h3 class="faldoc_funcname"><a name="uncompressText">uncompressText()</a></h3>
<p class="item_brief">Uncompress a buffer into a text (classwide method). </p>
<p class="faldoc_funcdecl">ZLib.uncompressText( buffer )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">buffer</td><td class="faldoc_paramdesc">A MemBuf or string containing previusly compressed text data. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A uncompressed string. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_ZLibError.html">ZLibError</a></td><td class="faldoc_raisedesc">on decompression error. </td></tr>
</table>
</td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text"> The input <b>buffer</b> must be a string previously compressed with the <a href="./class_ZLib.html#compressText">ZLib.compressText</a> method, or the function will fail. </p>
</p>
<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>
