File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/HTTPUtils/FormData.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::HTTPUtils::FormData - RDoc 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"><a href="../../String.html">String</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li class="calls-super" ><a href="#method-i-3C-3C">#<<</a>
<li class="calls-super" ><a href="#method-i-5B-5D">#[]</a>
<li ><a href="#method-i-append_data">#append_data</a>
<li ><a href="#method-i-each_data">#each_data</a>
<li ><a href="#method-i-list">#list</a>
<li ><a href="#method-i-to_ary">#to_ary</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::HTTPUtils::FormData">
<h1 id="class-WEBrick::HTTPUtils::FormData" class="class">
class WEBrick::HTTPUtils::FormData
</h1>
<section class="description">
<p>Stores multipart form data. <a href="FormData.html"><code>FormData</code></a> objects are created when <a href="../HTTPUtils.html#method-c-parse_form_data"><code>WEBrick::HTTPUtils.parse_form_data</code></a> is called.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-filename" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">filename</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The filename of the form data part</p>
</div>
</div>
<div id="attribute-i-name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">name</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The name of the form data part</p>
</div>
</div>
</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">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="FormData.html"><code>FormData</code></a> object.</p>
<p><code>args</code> is an <a href="../../Array.html"><code>Array</code></a> of form data entries. One <a href="FormData.html"><code>FormData</code></a> will be created for each entry.</p>
<p>This is called by <a href="../HTTPUtils.html#method-c-parse_form_data"><code>WEBrick::HTTPUtils.parse_form_data</code></a> for you</p>
<div class="method-calls-super">
Calls superclass method
<a href="../../String.html#method-c-new"><code>String::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/httputils.rb, line 266</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-ivar">@name</span> = <span class="ruby-ivar">@filename</span> = <span class="ruby-ivar">@next_data</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-ivar">@raw_header</span> = []
<span class="ruby-ivar">@header</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">super</span>(<span class="ruby-string">""</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@raw_header</span> = <span class="ruby-constant">EmptyRawHeader</span>
<span class="ruby-ivar">@header</span> = <span class="ruby-constant">EmptyHeader</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">args</span>.<span class="ruby-identifier">shift</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-ivar">@next_data</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</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-3C-3C" class="method-detail ">
<div class="method-heading">
<span class="method-name"><<</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds <code>str</code> to this <a href="FormData.html"><code>FormData</code></a> which may be the body, a header or a header entry.</p>
<p>This is called by <a href="../HTTPUtils.html#method-c-parse_form_data"><code>WEBrick::HTTPUtils.parse_form_data</code></a> for you</p>
<div class="method-calls-super">
Calls superclass method
<a href="../../String.html#method-i-3C-3C"><code>String#<<</code></a>
</div>
<div class="method-source-code" id="3C-3C-source">
<pre><span class="ruby-comment"># File lib/webrick/httputils.rb, line 299</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@header</span>
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">==</span> <span class="ruby-constant">CRLF</span>
<span class="ruby-ivar">@header</span> = <span class="ruby-constant">HTTPUtils</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse_header</span>(<span class="ruby-ivar">@raw_header</span>.<span class="ruby-identifier">join</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">cd</span> = <span class="ruby-keyword">self</span>[<span class="ruby-string">'content-disposition'</span>]
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/\s+name="(.*?)"/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">cd</span> <span class="ruby-keyword">then</span> <span class="ruby-ivar">@name</span> = <span class="ruby-node">$1</span> <span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/\s+filename="(.*?)"/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">cd</span> <span class="ruby-keyword">then</span> <span class="ruby-ivar">@filename</span> = <span class="ruby-node">$1</span> <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@raw_header</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">str</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">(*key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Retrieves the header at the first entry in <code>key</code></p>
<div class="method-calls-super">
Calls superclass method
<a href="../../String.html#method-i-5B-5D"><code>String#[]</code></a>
</div>
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/webrick/httputils.rb, line 285</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">key</span>)
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@header</span>[<span class="ruby-identifier">key</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">downcase</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">", "</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">StandardError</span>, <span class="ruby-constant">NameError</span>
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-append_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">append_data</span><span
class="method-args">(data)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds <code>data</code> at the end of the chain of entries</p>
<p>This is called by <a href="../HTTPUtils.html#method-c-parse_form_data"><code>WEBrick::HTTPUtils.parse_form_data</code></a> for you.</p>
<div class="method-source-code" id="append_data-source">
<pre><span class="ruby-comment"># File lib/webrick/httputils.rb, line 319</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">append_data</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-identifier">tmp</span> = <span class="ruby-keyword">self</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">tmp</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">tmp</span>.<span class="ruby-identifier">next_data</span>
<span class="ruby-identifier">tmp</span>.<span class="ruby-identifier">next_data</span> = <span class="ruby-identifier">data</span>
<span class="ruby-keyword">break</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">tmp</span> = <span class="ruby-identifier">tmp</span>.<span class="ruby-identifier">next_data</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">each_data</span><span
class="method-args">() { |tmp| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Yields each entry in this <a href="FormData.html"><code>FormData</code></a></p>
<div class="method-source-code" id="each_data-source">
<pre><span class="ruby-comment"># File lib/webrick/httputils.rb, line 334</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each_data</span>
<span class="ruby-identifier">tmp</span> = <span class="ruby-keyword">self</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">tmp</span>
<span class="ruby-identifier">next_data</span> = <span class="ruby-identifier">tmp</span>.<span class="ruby-identifier">next_data</span>
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">tmp</span>)
<span class="ruby-identifier">tmp</span> = <span class="ruby-identifier">next_data</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-list" class="method-detail ">
<div class="method-heading">
<span class="method-name">list</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns all the <a href="FormData.html"><code>FormData</code></a> as an <a href="../../Array.html"><code>Array</code></a></p>
<div class="method-source-code" id="list-source">
<pre><span class="ruby-comment"># File lib/webrick/httputils.rb, line 346</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">list</span>
<span class="ruby-identifier">ret</span> = []
<span class="ruby-identifier">each_data</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_s</span>
}
<span class="ruby-identifier">ret</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="FormData.html#method-i-to_ary">to_ary</a>
</div>
</div>
<div id="method-i-to_ary" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">to_ary</span><span
class="method-args">()</span>
</div>
<div class="method-description">
<p>A <a href="FormData.html"><code>FormData</code></a> will behave like an <a href="../../Array.html"><code>Array</code></a></p>
</div>
<div class="aliases">
Alias for: <a href="FormData.html#method-i-list">list</a>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>This FormData's body</p>
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/webrick/httputils.rb, line 362</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
<span class="ruby-constant">String</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</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>