File: C:/Ruby27-x64/share/doc/ruby/html/Base64.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Base64 - 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-decode64">#decode64</a>
<li ><a href="#method-i-encode64">#encode64</a>
<li ><a href="#method-i-strict_decode64">#strict_decode64</a>
<li ><a href="#method-i-strict_encode64">#strict_encode64</a>
<li ><a href="#method-i-urlsafe_decode64">#urlsafe_decode64</a>
<li ><a href="#method-i-urlsafe_encode64">#urlsafe_encode64</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Base64">
<h1 id="module-Base64" class="module">
module Base64
</h1>
<section class="description">
<p>The <a href="Base64.html"><code>Base64</code></a> module provides for the encoding (<a href="Base64.html#method-i-encode64"><code>encode64</code></a>, <a href="Base64.html#method-i-strict_encode64"><code>strict_encode64</code></a>, <a href="Base64.html#method-i-urlsafe_encode64"><code>urlsafe_encode64</code></a>) and decoding (<a href="Base64.html#method-i-decode64"><code>decode64</code></a>, <a href="Base64.html#method-i-strict_decode64"><code>strict_decode64</code></a>, <a href="Base64.html#method-i-urlsafe_decode64"><code>urlsafe_decode64</code></a>) of binary data using a <a href="Base64.html"><code>Base64</code></a> representation.</p>
<h2 id="module-Base64-label-Example">Example<span><a href="#module-Base64-label-Example">¶</a> <a href="#top">↑</a></span></h2>
<p>A simple encoding and decoding.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"base64"</span>
<span class="ruby-identifier">enc</span> = <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">encode64</span>(<span class="ruby-string">'Send reinforcements'</span>)
<span class="ruby-comment"># -> "U2VuZCByZWluZm9yY2VtZW50cw==\n"</span>
<span class="ruby-identifier">plain</span> = <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">decode64</span>(<span class="ruby-identifier">enc</span>)
<span class="ruby-comment"># -> "Send reinforcements"</span>
</pre>
<p>The purpose of using base64 to encode data is that it translates any binary data into purely printable characters.</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-decode64" class="method-detail ">
<div class="method-heading">
<span class="method-name">decode64</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the Base64-decoded version of <code>str</code>. This method complies with RFC 2045. Characters outside the base alphabet are ignored.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'base64'</span>
<span class="ruby-identifier">str</span> = <span class="ruby-string">'VGhpcyBpcyBsaW5lIG9uZQpUaGlzIG'</span> <span class="ruby-operator">+</span>
<span class="ruby-string">'lzIGxpbmUgdHdvClRoaXMgaXMgbGlu'</span> <span class="ruby-operator">+</span>
<span class="ruby-string">'ZSB0aHJlZQpBbmQgc28gb24uLi4K'</span>
<span class="ruby-identifier">puts</span> <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">decode64</span>(<span class="ruby-identifier">str</span>)
</pre>
<p><em>Generates:</em></p>
<pre class="ruby"><span class="ruby-constant">This</span> <span class="ruby-identifier">is</span> <span class="ruby-identifier">line</span> <span class="ruby-identifier">one</span>
<span class="ruby-constant">This</span> <span class="ruby-identifier">is</span> <span class="ruby-identifier">line</span> <span class="ruby-identifier">two</span>
<span class="ruby-constant">This</span> <span class="ruby-identifier">is</span> <span class="ruby-identifier">line</span> <span class="ruby-identifier">three</span>
<span class="ruby-constant">And</span> <span class="ruby-identifier">so</span> <span class="ruby-identifier">on</span><span class="ruby-operator">...</span>
</pre>
<div class="method-source-code" id="decode64-source">
<pre><span class="ruby-comment"># File lib/base64.rb, line 58</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">decode64</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">unpack1</span>(<span class="ruby-string">"m"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-encode64" class="method-detail ">
<div class="method-heading">
<span class="method-name">encode64</span><span
class="method-args">(bin)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the Base64-encoded version of <code>bin</code>. This method complies with RFC 2045. Line feeds are added to every 60 encoded characters.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'base64'</span>
<span class="ruby-constant">Base64</span>.<span class="ruby-identifier">encode64</span>(<span class="ruby-string">"Now is the time for all good coders\nto learn Ruby"</span>)
</pre>
<p><em>Generates:</em></p>
<pre>Tm93IGlzIHRoZSB0aW1lIGZvciBhbGwgZ29vZCBjb2RlcnMKdG8gbGVhcm4g
UnVieQ==</pre>
<div class="method-source-code" id="encode64-source">
<pre><span class="ruby-comment"># File lib/base64.rb, line 38</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">encode64</span>(<span class="ruby-identifier">bin</span>)
[<span class="ruby-identifier">bin</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">"m"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-strict_decode64" class="method-detail ">
<div class="method-heading">
<span class="method-name">strict_decode64</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the Base64-decoded version of <code>str</code>. This method complies with RFC 4648. <a href="ArgumentError.html"><code>ArgumentError</code></a> is raised if <code>str</code> is incorrectly padded or contains non-alphabet characters. Note that CR or LF are also rejected.</p>
<div class="method-source-code" id="strict_decode64-source">
<pre><span class="ruby-comment"># File lib/base64.rb, line 73</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">strict_decode64</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">unpack1</span>(<span class="ruby-string">"m0"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-strict_encode64" class="method-detail ">
<div class="method-heading">
<span class="method-name">strict_encode64</span><span
class="method-args">(bin)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the Base64-encoded version of <code>bin</code>. This method complies with RFC 4648. No line feeds are added.</p>
<div class="method-source-code" id="strict_encode64-source">
<pre><span class="ruby-comment"># File lib/base64.rb, line 65</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">strict_encode64</span>(<span class="ruby-identifier">bin</span>)
[<span class="ruby-identifier">bin</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">"m0"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-urlsafe_decode64" class="method-detail ">
<div class="method-heading">
<span class="method-name">urlsafe_decode64</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the Base64-decoded version of <code>str</code>. This method complies with “Base 64 <a href="Encoding.html"><code>Encoding</code></a> with URL and Filename Safe Alphabet'' in RFC 4648. The alphabet uses '-' instead of '+' and '_' instead of '/'.</p>
<p>The padding character is optional. This method accepts both correctly-padded and unpadded input. Note that it still rejects incorrectly-padded input.</p>
<div class="method-source-code" id="urlsafe_decode64-source">
<pre><span class="ruby-comment"># File lib/base64.rb, line 98</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">urlsafe_decode64</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-comment"># NOTE: RFC 4648 does say nothing about unpadded input, but says that</span>
<span class="ruby-comment"># "the excess pad characters MAY also be ignored", so it is inferred that</span>
<span class="ruby-comment"># unpadded input is also acceptable.</span>
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">str</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">"-_"</span>, <span class="ruby-string">"+/"</span>)
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">str</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-string">"="</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">%</span> <span class="ruby-value">4</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">str</span>.<span class="ruby-identifier">ljust</span>((<span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>) <span class="ruby-operator">&</span> <span class="ruby-operator">~</span><span class="ruby-value">3</span>, <span class="ruby-string">"="</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">strict_decode64</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-urlsafe_encode64" class="method-detail ">
<div class="method-heading">
<span class="method-name">urlsafe_encode64</span><span
class="method-args">(bin, padding: true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the Base64-encoded version of <code>bin</code>. This method complies with “Base 64 <a href="Encoding.html"><code>Encoding</code></a> with URL and Filename Safe Alphabet'' in RFC 4648. The alphabet uses '-' instead of '+' and '_' instead of '/'. Note that the result can still contain '='. You can remove the padding by setting <code>padding</code> as false.</p>
<div class="method-source-code" id="urlsafe_encode64-source">
<pre><span class="ruby-comment"># File lib/base64.rb, line 83</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">urlsafe_encode64</span>(<span class="ruby-identifier">bin</span>, <span class="ruby-value">padding:</span> <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">strict_encode64</span>(<span class="ruby-identifier">bin</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">tr!</span>(<span class="ruby-string">"+/"</span>, <span class="ruby-string">"-_"</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">delete!</span>(<span class="ruby-string">"="</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">padding</span>
<span class="ruby-identifier">str</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>