<?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::File</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::File</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/rack/file_rb.html">
lib/rack/file.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>
<a href="File.html">Rack::File</a> serves files below the <tt>root</tt>
directory given, according to the path info of the <a
href="../Rack.html">Rack</a> request. e.g. when <a
href="File.html#M000260">Rack::File.new</a>("/etc") is used, you
can access ‘passwd’ file as <a
href="http://localhost:9292/passwd">localhost:9292/passwd</a>
</p>
<p>
Handlers can detect if bodies are a <a href="File.html">Rack::File</a>, and
use mechanisms like sendfile on the <tt>path</tt>.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000262">_call</a>
<a href="#M000261">call</a>
<a href="#M000264">each</a>
<a href="#M000260">new</a>
<a href="#M000263">serving</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="constants-list">
<h3 class="section-bar">Constants</h3>
<div class="name-list">
<table summary="Constants">
<tr class="top-aligned-row context-row">
<td class="context-item-name">ALLOWED_VERBS</td>
<td>=</td>
<td class="context-item-value">%w[GET HEAD OPTIONS]</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">ALLOW_HEADER</td>
<td>=</td>
<td class="context-item-value">ALLOWED_VERBS.join(', ')</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">F</td>
<td>=</td>
<td class="context-item-value">::File</td>
</tr>
</table>
</div>
</div>
<div id="aliases-list">
<h3 class="section-bar">External Aliases</h3>
<div class="name-list">
<table summary="aliases">
<tr class="top-aligned-row context-row">
<td class="context-item-name">path</td>
<td>-></td>
<td class="context-item-value">to_path</td>
</tr>
</table>
</div>
</div>
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">cache_control</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">path</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">root</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000260" class="method-detail">
<a name="M000260"></a>
<div class="method-heading">
<a href="File.src/M000260.html" target="Code" class="method-signature"
onclick="popupCode('File.src/M000260.html');return false;">
<span class="method-name">new</span><span class="method-args">(root, headers={}, default_mime = 'text/plain')</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000262" class="method-detail">
<a name="M000262"></a>
<div class="method-heading">
<a href="File.src/M000262.html" target="Code" class="method-signature"
onclick="popupCode('File.src/M000262.html');return false;">
<span class="method-name">_call</span><span class="method-args">(env)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000261" class="method-detail">
<a name="M000261"></a>
<div class="method-heading">
<a href="File.src/M000261.html" target="Code" class="method-signature"
onclick="popupCode('File.src/M000261.html');return false;">
<span class="method-name">call</span><span class="method-args">(env)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000264" class="method-detail">
<a name="M000264"></a>
<div class="method-heading">
<a href="File.src/M000264.html" target="Code" class="method-signature"
onclick="popupCode('File.src/M000264.html');return false;">
<span class="method-name">each</span><span class="method-args">() {|part| ...}</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000263" class="method-detail">
<a name="M000263"></a>
<div class="method-heading">
<a href="File.src/M000263.html" target="Code" class="method-signature"
onclick="popupCode('File.src/M000263.html');return false;">
<span class="method-name">serving</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> |