<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Parrot - GzipHandle PMC</title>
<link rel="stylesheet" type="text/css"
href="../../../resources/parrot.css"
media="all">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
</head>
<body>
<div id="wrapper">
<div id="header">
<a href="http://www.parrot.org">
<img border=0 src="../../../resources/parrot_logo.png" id="logo" alt="parrot">
</a>
</div> <!-- "header" -->
<div id="divider"></div>
<div id="mainbody">
<div id="breadcrumb">
<a href="../../../html/index.html">Home</a> » <a href="../../../html/pmc.html">PMCs</a> » GzipHandle PMC
</div>
<h1><a name="NAME"
>NAME</a></h1>
<p>src/dynpmc/gziphandle.pmc - GzipHandle PMC</p>
<h1><a name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>The GzipHandle PMC performs I/O operations on a source or destination file.</p>
<p>This PMC wraps the zlib.</p>
<h2><a name="Vtable_Functions"
>Vtable Functions</a></h2>
<dl>
<dt><a name="void_init()"
><b><code>void init()</b></code></a></dt>
Initializes a newly created GzipHandle object.
<dt><a name="INTVAL_get_bool()"
><b><code>INTVAL get_bool()</b></code></a></dt>
Returns whether the GzipHandle has reached the end of the file.</dl>
<h2><a name="Stream-Oriented_Methods"
>Stream-Oriented Methods</a></h2>
<dl>
<dt><a name="METHOD_open(STRING_*filename,_STRING_*mode_:optional)"
><b><code>METHOD open(STRING *filename, STRING *mode :optional)</b></code></a></dt>
Opens the file at the given filename (including path) with the given mode.
The invocant is modified and becomes an open filehandle.
<dt><a name="METHOD_close()"
><b><code>METHOD close()</b></code></a></dt>
Close the gziphandle.
<dt><a name="METHOD_eof()"
><b><code>METHOD eof()</b></code></a></dt>
Returns true if the gziphandle is at end-of-file,
returns false otherwise.
<dt><a name="METHOD_flush()"
><b><code>METHOD flush()</b></code></a></dt>
Flushes the gziphandle.
<dt><a name="METHOD_print([INTVAL|FLOATVAL|STRING_*|PMC*]_value)"
><b><code>METHOD print([INTVAL|FLOATVAL|STRING *|PMC*] value)</b></code></a></dt>
Print the passed in integer,
number,
string,
or PMC to the gziphandle.
(Integers,
numbers,
and strings are auto-boxed as PMCs.)
<dt><a name="METHOD_puts(STRING_*value)"
><b><code>METHOD puts(STRING *value)</b></code></a></dt>
Print the string to the gziphandle.
<dt><a name="METHOD_read(INTVAL_bytes)"
><b><code>METHOD read(INTVAL bytes)</b></code></a></dt>
Read the given number of bytes from the gziphandle and return them in a string.</dl>
<h2><a name="Basic_Methods"
>Basic Methods</a></h2>
<dl>
<dt><a name="METHOD_version()"
><b><code>METHOD version()</b></code></a></dt>
Returns a string with the zlib version.</dl>
</div> <!-- "mainbody" -->
<div id="divider"></div>
<div id="footer">
Copyright © 2002-2011, Parrot Foundation.
</div>
</div> <!-- "wrapper" -->
</body>
</html>
