X7ROOT File Manager
Current Path:
/opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.17/rdoc/Rack
opt
/
cpanel
/
ea-ruby27
/
root
/
usr
/
share
/
gems
/
doc
/
rack-2.2.17
/
rdoc
/
Rack
/
π
..
π
Auth
π
Auth.html
(2.38 KB)
π
BodyProxy.html
(9.98 KB)
π
Builder.html
(38.08 KB)
π
Cascade.html
(12.24 KB)
π
Chunked
π
Chunked.html
(10.4 KB)
π
CommonLogger.html
(14.29 KB)
π
ConditionalGet.html
(15.24 KB)
π
Config.html
(5.86 KB)
π
ContentLength.html
(7.8 KB)
π
ContentType.html
(6.74 KB)
π
Deflater
π
Deflater.html
(16.41 KB)
π
Directory
π
Directory.html
(26.63 KB)
π
ETag.html
(15 KB)
π
Events
π
Events.html
(17.78 KB)
π
File.html
(25.36 KB)
π
Files
π
Files.html
(25.36 KB)
π
ForwardRequest.html
(6.74 KB)
π
Handler
π
Handler.html
(14.41 KB)
π
Head.html
(6.18 KB)
π
Lint
π
Lint.html
(4.01 KB)
π
Lobster.html
(7.83 KB)
π
Lock.html
(7.63 KB)
π
Logger.html
(5.77 KB)
π
MediaType.html
(9.96 KB)
π
MethodOverride.html
(11.56 KB)
π
Mime.html
(13.64 KB)
π
MockRequest
π
MockRequest.html
(29.98 KB)
π
MockResponse
π
MockResponse.html
(21.32 KB)
π
Multipart
π
Multipart.html
(11.13 KB)
π
NullLogger.html
(26.91 KB)
π
QueryParser
π
QueryParser.html
(34.01 KB)
π
Recursive.html
(10.01 KB)
π
RegexpExtensions.html
(3.93 KB)
π
Reloader
π
Reloader.html
(10.95 KB)
π
Request
π
Request.html
(9.89 KB)
π
Response
π
Response.html
(26.61 KB)
π
RewindableInput.html
(16.7 KB)
π
Runtime.html
(6.83 KB)
π
Sendfile.html
(19.63 KB)
π
Server
π
Server.html
(53 KB)
π
Session
π
Session.html
(2.61 KB)
π
ShowExceptions.html
(18.03 KB)
π
ShowStatus.html
(8.99 KB)
π
Static.html
(25.86 KB)
π
TempfileReaper.html
(6.39 KB)
π
URLMap.html
(16.28 KB)
π
Utils
π
Utils.html
(73.9 KB)
Editing: ETag.html
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>class Rack::ETag - rack-2.2.17 Documentation</title> <script type="text/javascript"> var rdoc_rel_prefix = "../"; var index_rel_prefix = "../"; </script> <script src="../js/navigation.js" defer></script> <script src="../js/search.js" defer></script> <script src="../js/search_index.js" defer></script> <script src="../js/searcher.js" defer></script> <script src="../js/darkfish.js" defer></script> <link href="../css/fonts.css" rel="stylesheet"> <link href="../css/rdoc.css" rel="stylesheet"> <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> <div id="home-section" role="region" title="Quick navigation" class="nav-section"> <h2> <a href="../index.html" rel="home">Home</a> </h2> <div id="table-of-contents-navigation"> <a href="../table_of_contents.html#pages">Pages</a> <a href="../table_of_contents.html#classes">Classes</a> <a href="../table_of_contents.html#methods">Methods</a> </div> </div> <div id="search-section" role="search" class="project-section initially-hidden"> <form action="#" method="get" accept-charset="utf-8"> <div id="search-field-wrapper"> <input id="search-field" role="combobox" aria-label="Search" aria-autocomplete="list" aria-controls="search-results" type="text" name="search" placeholder="Search" spellcheck="false" title="Type to search, Up and Down to navigate, Enter to load"> </div> <ul id="search-results" aria-label="Search Results" aria-busy="false" aria-expanded="false" aria-atomic="false" class="initially-hidden"></ul> </form> </div> </div> <div id="class-metadata"> <div id="parent-class-section" class="nav-section"> <h3>Parent</h3> <p class="link">Object </div> <!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> <li ><a href="#method-c-new">::new</a> <li ><a href="#method-i-call">#call</a> <li ><a href="#method-i-digest_body">#digest_body</a> <li ><a href="#method-i-etag_body-3F">#etag_body?</a> <li ><a href="#method-i-etag_status-3F">#etag_status?</a> <li ><a href="#method-i-skip_caching-3F">#skip_caching?</a> </ul> </div> </div> </nav> <main role="main" aria-labelledby="class-Rack::ETag"> <h1 id="class-Rack::ETag" class="class"> class Rack::ETag </h1> <section class="description"> <p>Automatically sets the <a href="ETag.html"><code>ETag</code></a> header on all String bodies.</p> <p>The <a href="ETag.html"><code>ETag</code></a> header is skipped if <a href="ETag.html"><code>ETag</code></a> or Last-Modified headers are sent or if a sendfile body (body.responds_to :to_path) is given (since such cases should be handled by apache/nginx).</p> <p>On initialization, you can pass two parameters: a Cache-Control directive used when Etag is absent and a directive when it is present. The first defaults to nil, while the second defaults to βmax-age=0, private, must-revalidateβ</p> </section> <section id="5Buntitled-5D" class="documentation-section"> <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> <dt id="DEFAULT_CACHE_CONTROL">DEFAULT_CACHE_CONTROL <dd> <dt id="ETAG_STRING">ETAG_STRING <dd> </dl> </section> <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> <div id="method-c-new" class="method-detail "> <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(app, no_cache_control = nil, cache_control = DEFAULT_CACHE_CONTROL)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/rack/etag.rb, line 20</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">app</span>, <span class="ruby-identifier">no_cache_control</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">cache_control</span> = <span class="ruby-constant">DEFAULT_CACHE_CONTROL</span>) <span class="ruby-ivar">@app</span> = <span class="ruby-identifier">app</span> <span class="ruby-ivar">@cache_control</span> = <span class="ruby-identifier">cache_control</span> <span class="ruby-ivar">@no_cache_control</span> = <span class="ruby-identifier">no_cache_control</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> </section> <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> <div id="method-i-call" class="method-detail "> <div class="method-heading"> <span class="method-name">call</span><span class="method-args">(env)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="call-source"> <pre><span class="ruby-comment"># File lib/rack/etag.rb, line 26</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">call</span>(<span class="ruby-identifier">env</span>) <span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">body</span> = <span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>) <span class="ruby-identifier">headers</span> = <span class="ruby-constant">Utils</span><span class="ruby-operator">::</span><span class="ruby-constant">HeaderHash</span>[<span class="ruby-identifier">headers</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">etag_status?</span>(<span class="ruby-identifier">status</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">etag_body?</span>(<span class="ruby-identifier">body</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">skip_caching?</span>(<span class="ruby-identifier">headers</span>) <span class="ruby-identifier">original_body</span> = <span class="ruby-identifier">body</span> <span class="ruby-identifier">digest</span>, <span class="ruby-identifier">new_body</span> = <span class="ruby-identifier">digest_body</span>(<span class="ruby-identifier">body</span>) <span class="ruby-identifier">body</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">BodyProxy</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">new_body</span>) <span class="ruby-keyword">do</span> <span class="ruby-identifier">original_body</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">original_body</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:close</span>) <span class="ruby-keyword">end</span> <span class="ruby-identifier">headers</span>[<span class="ruby-constant">ETAG_STRING</span>] = <span class="ruby-node">%(W/"#{digest}")</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">digest</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">headers</span>[<span class="ruby-constant">CACHE_CONTROL</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">digest</span> <span class="ruby-identifier">headers</span>[<span class="ruby-constant">CACHE_CONTROL</span>] = <span class="ruby-ivar">@cache_control</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@cache_control</span> <span class="ruby-keyword">else</span> <span class="ruby-identifier">headers</span>[<span class="ruby-constant">CACHE_CONTROL</span>] = <span class="ruby-ivar">@no_cache_control</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@no_cache_control</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> [<span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">body</span>] <span class="ruby-keyword">end</span></pre> </div> </div> </div> </section> <section id="private-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Private Instance Methods</h3> </header> <div id="method-i-digest_body" class="method-detail "> <div class="method-heading"> <span class="method-name">digest_body</span><span class="method-args">(body)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="digest_body-source"> <pre><span class="ruby-comment"># File lib/rack/etag.rb, line 65</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">digest_body</span>(<span class="ruby-identifier">body</span>) <span class="ruby-identifier">parts</span> = [] <span class="ruby-identifier">digest</span> = <span class="ruby-keyword">nil</span> <span class="ruby-identifier">body</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span> <span class="ruby-identifier">parts</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">part</span> (<span class="ruby-identifier">digest</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA256</span>.<span class="ruby-identifier">new</span>) <span class="ruby-operator"><<</span> <span class="ruby-identifier">part</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">end</span> [<span class="ruby-identifier">digest</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">digest</span>.<span class="ruby-identifier">hexdigest</span>.<span class="ruby-identifier">byteslice</span>(<span class="ruby-value">0</span>, <span class="ruby-value">32</span>), <span class="ruby-identifier">parts</span>] <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-etag_body-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">etag_body?</span><span class="method-args">(body)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="etag_body-3F-source"> <pre><span class="ruby-comment"># File lib/rack/etag.rb, line 57</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">etag_body?</span>(<span class="ruby-identifier">body</span>) <span class="ruby-operator">!</span><span class="ruby-identifier">body</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_path</span>) <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-etag_status-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">etag_status?</span><span class="method-args">(status)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="etag_status-3F-source"> <pre><span class="ruby-comment"># File lib/rack/etag.rb, line 53</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">etag_status?</span>(<span class="ruby-identifier">status</span>) <span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-value">201</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-skip_caching-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">skip_caching?</span><span class="method-args">(headers)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="skip_caching-3F-source"> <pre><span class="ruby-comment"># File lib/rack/etag.rb, line 61</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">skip_caching?</span>(<span class="ruby-identifier">headers</span>) <span class="ruby-identifier">headers</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-constant">ETAG_STRING</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">headers</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">'Last-Modified'</span>) <span class="ruby-keyword">end</span></pre> </div> </div> </div> </section> </section> </main> <footer id="validator-badges" role="contentinfo"> <p><a href="https://validator.w3.org/check/referer">Validate</a> <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. </footer>
Upload File
Create Folder