Server : LiteSpeed System : Linux premium163.web-hosting.com 4.18.0-513.18.1.lve.el8.x86_64 #1 SMP Thu Feb 22 12:55:50 UTC 2024 x86_64 User : infihsqw ( 644) PHP Version : 8.1.29 Disable Function : NONE Directory : /opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.8/rdoc/Rack/ |
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Rack::Multipart - rack-2.2.8 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="module">
<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">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-build_multipart">::build_multipart</a>
<li ><a href="#method-c-extract_multipart">::extract_multipart</a>
<li ><a href="#method-c-parse_multipart">::parse_multipart</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Rack::Multipart">
<h1 id="module-Rack::Multipart" class="module">
module Rack::Multipart
</h1>
<section class="description">
<p>A multipart form data parser, adapted from IOWA.</p>
<p>Usually, Rack::Request#POST takes care of calling this.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ATTRIBUTE">ATTRIBUTE
<dd>
<dt id="ATTRIBUTE_CHAR">ATTRIBUTE_CHAR
<dd><p>Updated definitions from RFC 2231</p>
<dt id="BROKEN">BROKEN
<dd>
<dt id="CONDISP">CONDISP
<dd>
<dt id="DISPPARM">DISPPARM
<dd>
<dt id="EOL">EOL
<dd>
<dt id="EXTENDED_INITIAL_NAME">EXTENDED_INITIAL_NAME
<dd>
<dt id="EXTENDED_INITIAL_PARAMETER">EXTENDED_INITIAL_PARAMETER
<dd>
<dt id="EXTENDED_INITIAL_VALUE">EXTENDED_INITIAL_VALUE
<dd>
<dt id="EXTENDED_OTHER_NAME">EXTENDED_OTHER_NAME
<dd>
<dt id="EXTENDED_OTHER_PARAMETER">EXTENDED_OTHER_PARAMETER
<dd>
<dt id="EXTENDED_OTHER_VALUE">EXTENDED_OTHER_VALUE
<dd>
<dt id="EXTENDED_PARAMETER">EXTENDED_PARAMETER
<dd>
<dt id="MULTIPART">MULTIPART
<dd>
<dt id="MULTIPART_BOUNDARY">MULTIPART_BOUNDARY
<dd>
<dt id="MULTIPART_CONTENT_DISPOSITION">MULTIPART_CONTENT_DISPOSITION
<dd>
<dt id="MULTIPART_CONTENT_ID">MULTIPART_CONTENT_ID
<dd>
<dt id="MULTIPART_CONTENT_TYPE">MULTIPART_CONTENT_TYPE
<dd>
<dt id="REGULAR_PARAMETER">REGULAR_PARAMETER
<dd>
<dt id="REGULAR_PARAMETER_NAME">REGULAR_PARAMETER_NAME
<dd>
<dt id="RFC2183">RFC2183
<dd>
<dt id="SECTION">SECTION
<dd>
<dt id="TOKEN">TOKEN
<dd>
<dt id="VALUE">VALUE
<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-build_multipart" class="method-detail ">
<div class="method-heading">
<span class="method-name">build_multipart</span><span
class="method-args">(params, first = true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="build_multipart-source">
<pre><span class="ruby-comment"># File lib/rack/multipart.rb, line 58</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_multipart</span>(<span class="ruby-identifier">params</span>, <span class="ruby-identifier">first</span> = <span class="ruby-keyword">true</span>)
<span class="ruby-constant">Generator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>, <span class="ruby-identifier">first</span>).<span class="ruby-identifier">dump</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-extract_multipart" class="method-detail ">
<div class="method-heading">
<span class="method-name">extract_multipart</span><span
class="method-args">(req, params = Rack::Utils.default_query_parser)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="extract_multipart-source">
<pre><span class="ruby-comment"># File lib/rack/multipart.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">extract_multipart</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">params</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">default_query_parser</span>)
<span class="ruby-identifier">io</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">get_header</span>(<span class="ruby-constant">RACK_INPUT</span>)
<span class="ruby-identifier">io</span>.<span class="ruby-identifier">rewind</span>
<span class="ruby-identifier">content_length</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">content_length</span>
<span class="ruby-identifier">content_length</span> = <span class="ruby-identifier">content_length</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">content_length</span>
<span class="ruby-identifier">tempfile</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">get_header</span>(<span class="ruby-constant">RACK_MULTIPART_TEMPFILE_FACTORY</span>) <span class="ruby-operator">||</span> <span class="ruby-constant">Parser</span><span class="ruby-operator">::</span><span class="ruby-constant">TEMPFILE_FACTORY</span>
<span class="ruby-identifier">bufsize</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">get_header</span>(<span class="ruby-constant">RACK_MULTIPART_BUFFER_SIZE</span>) <span class="ruby-operator">||</span> <span class="ruby-constant">Parser</span><span class="ruby-operator">::</span><span class="ruby-constant">BUFSIZE</span>
<span class="ruby-identifier">info</span> = <span class="ruby-constant">Parser</span>.<span class="ruby-identifier">parse</span> <span class="ruby-identifier">io</span>, <span class="ruby-identifier">content_length</span>, <span class="ruby-identifier">req</span>.<span class="ruby-identifier">get_header</span>(<span class="ruby-string">'CONTENT_TYPE'</span>), <span class="ruby-identifier">tempfile</span>, <span class="ruby-identifier">bufsize</span>, <span class="ruby-identifier">params</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">set_header</span>(<span class="ruby-constant">RACK_TEMPFILES</span>, <span class="ruby-identifier">info</span>.<span class="ruby-identifier">tmp_files</span>)
<span class="ruby-identifier">info</span>.<span class="ruby-identifier">params</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-parse_multipart" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_multipart</span><span
class="method-args">(env, params = Rack::Utils.default_query_parser)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="parse_multipart-source">
<pre><span class="ruby-comment"># File lib/rack/multipart.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_multipart</span>(<span class="ruby-identifier">env</span>, <span class="ruby-identifier">params</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">default_query_parser</span>)
<span class="ruby-identifier">extract_multipart</span> <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">env</span>), <span class="ruby-identifier">params</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>