Mini Shell
<?xml version="1.0" encoding="iso-8859-1"?>
<!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" xml:lang="en" lang="en">
<head>
<title>Class: Rack::Deflater</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">Rack::Deflater</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/rack/deflater_rb.html">
lib/rack/deflater.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
This middleware enables compression of http responses.
</p>
<p>
Currently supported compression algorithms:
</p>
<pre>
* gzip
* deflate
* identity (no transformation)
</pre>
<p>
The middleware automatically detects when compression is supported and
allowed. For example no transformation is made when a cache directive of
‘no-transform’ is present, or when the response status code is
one that doesn‘t allow an entity body.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000250">call</a>
<a href="#M000249">new</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="class-list">
<h3 class="section-bar">Classes and Modules</h3>
Class <a href="Deflater/DeflateStream.html" class="link">Rack::Deflater::DeflateStream</a><br />
Class <a href="Deflater/GzipStream.html" class="link">Rack::Deflater::GzipStream</a><br />
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000249" class="method-detail">
<a name="M000249"></a>
<div class="method-heading">
<a href="Deflater.src/M000249.html" target="Code" class="method-signature"
onclick="popupCode('Deflater.src/M000249.html');return false;">
<span class="method-name">new</span><span class="method-args">(app, options = {})</span>
</a>
</div>
<div class="method-description">
<p>
Creates <a href="Deflater.html">Rack::Deflater</a> middleware.
</p>
<dl>
<dt>app</dt><dd>rack app instance
</dd>
<dt>options</dt><dd>hash of deflater options, i.e. ‘if’ - a lambda enabling /
disabling deflation based on returned boolean value
<pre>
e.g use Rack::Deflater, :if => lambda { |env, status, headers, body| body.length > 512 }
</pre>
<p>
‘include’ - a list of content types that should be compressed
</p>
</dd>
</dl>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000250" class="method-detail">
<a name="M000250"></a>
<div class="method-heading">
<a href="Deflater.src/M000250.html" target="Code" class="method-signature"
onclick="popupCode('Deflater.src/M000250.html');return false;">
<span class="method-name">call</span><span class="method-args">(env)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
Zerion Mini Shell 1.0