File: C:/Ruby27-x64/share/doc/ruby/html/URI/Escape.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module URI::Escape - 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="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-i-decode">#decode</a>
<li ><a href="#method-i-encode">#encode</a>
<li ><a href="#method-i-escape">#escape</a>
<li ><a href="#method-i-unescape">#unescape</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-URI::Escape">
<h1 id="module-URI::Escape" class="module">
module URI::Escape
</h1>
<section class="description">
<p><a href="../Module.html"><code>Module</code></a> for escaping unsafe characters with codes.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-decode" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">decode</span><span
class="method-args">(*arg)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Escape.html#method-i-unescape">unescape</a>
</div>
</div>
<div id="method-i-encode" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">encode</span><span
class="method-args">(*arg)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Escape.html#method-i-escape">escape</a>
</div>
</div>
<div id="method-i-escape" class="method-detail ">
<div class="method-heading">
<span class="method-name">escape</span><span
class="method-args">(*arg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<h2 id="method-i-escape-label-Synopsis">Synopsis<span><a href="#method-i-escape-label-Synopsis">¶</a> <a href="#top">↑</a></span></h2>
<pre>URI.escape(str [, unsafe])</pre>
<h2 id="method-i-escape-label-Args">Args<span><a href="#method-i-escape-label-Args">¶</a> <a href="#top">↑</a></span></h2>
<dl class="rdoc-list note-list"><dt><code>str</code>
<dd>
<p><a href="../String.html"><code>String</code></a> to replaces in.</p>
</dd><dt><code>unsafe</code>
<dd>
<p><a href="../Regexp.html"><code>Regexp</code></a> that matches all symbols that must be replaced with codes. By default uses <code>UNSAFE</code>. When this argument is a <a href="../String.html"><code>String</code></a>, it represents a character set.</p>
</dd></dl>
<h2 id="method-i-escape-label-Description">Description<span><a href="#method-i-escape-label-Description">¶</a> <a href="#top">↑</a></span></h2>
<p>Escapes the string, replacing all unsafe characters with codes.</p>
<p>This method is obsolete and should not be used. Instead, use <a href="../CGI/Util.html#method-i-escape"><code>CGI.escape</code></a>, <a href="../URI.html#method-c-encode_www_form"><code>URI.encode_www_form</code></a> or <a href="../URI.html#method-c-encode_www_form_component"><code>URI.encode_www_form_component</code></a> depending on your specific use case.</p>
<h2 id="method-i-escape-label-Usage">Usage<span><a href="#method-i-escape-label-Usage">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'uri'</span>
<span class="ruby-identifier">enc_uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-string">"http://example.com/?a=\11\15"</span>)
<span class="ruby-comment"># => "http://example.com/?a=%09%0D"</span>
<span class="ruby-constant">URI</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-identifier">enc_uri</span>)
<span class="ruby-comment"># => "http://example.com/?a=\t\r"</span>
<span class="ruby-constant">URI</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-string">"@?@!"</span>, <span class="ruby-string">"!?"</span>)
<span class="ruby-comment"># => "@%3F@%21"</span>
</pre>
<div class="method-source-code" id="escape-source">
<pre><span class="ruby-comment"># File lib/uri/common.rb, line 101</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">escape</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arg</span>)
<span class="ruby-identifier">warn</span> <span class="ruby-string">"URI.escape is obsolete"</span>, <span class="ruby-value">uplevel:</span> <span class="ruby-value">1</span>
<span class="ruby-constant">DEFAULT_PARSER</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Escape.html#method-i-encode">encode</a>
</div>
</div>
<div id="method-i-unescape" class="method-detail ">
<div class="method-heading">
<span class="method-name">unescape</span><span
class="method-args">(*arg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<h2 id="method-i-unescape-label-Synopsis">Synopsis<span><a href="#method-i-unescape-label-Synopsis">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-constant">URI</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-identifier">str</span>)
</pre>
<h2 id="method-i-unescape-label-Args">Args<span><a href="#method-i-unescape-label-Args">¶</a> <a href="#top">↑</a></span></h2>
<dl class="rdoc-list note-list"><dt><code>str</code>
<dd>
<p><a href="../String.html"><code>String</code></a> to unescape.</p>
</dd></dl>
<h2 id="method-i-unescape-label-Description">Description<span><a href="#method-i-unescape-label-Description">¶</a> <a href="#top">↑</a></span></h2>
<p>This method is obsolete and should not be used. Instead, use <a href="../CGI/Util.html#method-i-unescape"><code>CGI.unescape</code></a>, <a href="../URI.html#method-c-decode_www_form"><code>URI.decode_www_form</code></a> or <a href="../URI.html#method-c-decode_www_form_component"><code>URI.decode_www_form_component</code></a> depending on your specific use case.</p>
<h2 id="method-i-unescape-label-Usage">Usage<span><a href="#method-i-unescape-label-Usage">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'uri'</span>
<span class="ruby-identifier">enc_uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-string">"http://example.com/?a=\11\15"</span>)
<span class="ruby-comment"># => "http://example.com/?a=%09%0D"</span>
<span class="ruby-constant">URI</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-identifier">enc_uri</span>)
<span class="ruby-comment"># => "http://example.com/?a=\t\r"</span>
</pre>
<div class="method-source-code" id="unescape-source">
<pre><span class="ruby-comment"># File lib/uri/common.rb, line 132</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unescape</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arg</span>)
<span class="ruby-identifier">warn</span> <span class="ruby-string">"URI.unescape is obsolete"</span>, <span class="ruby-value">uplevel:</span> <span class="ruby-value">1</span>
<span class="ruby-constant">DEFAULT_PARSER</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Escape.html#method-i-decode">decode</a>
</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>