File: C:/Ruby27-x64/share/doc/ruby/html/Kconv.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Kconv - 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-c-guess">::guess</a>
<li ><a href="#method-c-iseuc">::iseuc</a>
<li ><a href="#method-c-isjis">::isjis</a>
<li ><a href="#method-c-issjis">::issjis</a>
<li ><a href="#method-c-isutf8">::isutf8</a>
<li ><a href="#method-c-kconv">::kconv</a>
<li ><a href="#method-c-toeuc">::toeuc</a>
<li ><a href="#method-c-tojis">::tojis</a>
<li ><a href="#method-c-tolocale">::tolocale</a>
<li ><a href="#method-c-tosjis">::tosjis</a>
<li ><a href="#method-c-toutf16">::toutf16</a>
<li ><a href="#method-c-toutf32">::toutf32</a>
<li ><a href="#method-c-toutf8">::toutf8</a>
<li ><a href="#method-i-guess">#guess</a>
<li ><a href="#method-i-iseuc">#iseuc</a>
<li ><a href="#method-i-isjis">#isjis</a>
<li ><a href="#method-i-issjis">#issjis</a>
<li ><a href="#method-i-isutf8">#isutf8</a>
<li ><a href="#method-i-kconv">#kconv</a>
<li ><a href="#method-i-toeuc">#toeuc</a>
<li ><a href="#method-i-tojis">#tojis</a>
<li ><a href="#method-i-tolocale">#tolocale</a>
<li ><a href="#method-i-tosjis">#tosjis</a>
<li ><a href="#method-i-toutf16">#toutf16</a>
<li ><a href="#method-i-toutf32">#toutf32</a>
<li ><a href="#method-i-toutf8">#toutf8</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Kconv">
<h1 id="module-Kconv" class="module">
module Kconv
</h1>
<section class="description">
<p>Kanji Converter for Ruby.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ASCII">ASCII
<dd><p><a href="Kconv.html#ASCII"><code>ASCII</code></a></p>
<dt id="AUTO">AUTO
<dd><p>Auto-Detect</p>
<dt id="BINARY">BINARY
<dd><p><a href="Kconv.html#BINARY"><code>BINARY</code></a></p>
<dt id="EUC">EUC
<dd><p>EUC-JP</p>
<dt id="JIS">JIS
<dd><p>ISO-2022-JP</p>
<dt id="NOCONV">NOCONV
<dd><p><a href="Kconv.html#NOCONV"><code>NOCONV</code></a></p>
<dt id="SJIS">SJIS
<dd><p>Shift_JIS</p>
<dt id="UNKNOWN">UNKNOWN
<dd><p><a href="Kconv.html#UNKNOWN"><code>UNKNOWN</code></a></p>
<dt id="UTF16">UTF16
<dd><p>UTF-16</p>
<dt id="UTF32">UTF32
<dd><p>UTF-32</p>
<dt id="UTF8">UTF8
<dd><p>UTF-8</p>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-guess" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
guess(str) → encoding
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Guess input encoding by <a href="NKF.html#method-c-guess"><code>NKF.guess</code></a></p>
<div class="method-source-code" id="guess-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 141</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">guess</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-operator">::</span><span class="ruby-constant">NKF</span><span class="ruby-operator">::</span><span class="ruby-identifier">guess</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-iseuc" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
iseuc(str) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether input encoding is EUC-JP or not.</p>
<p><strong>Note</strong> don't expect this return value is <a href="MatchData.html"><code>MatchData</code></a>.</p>
<div class="method-source-code" id="iseuc-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 156</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">iseuc</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-constant">EUC</span>).<span class="ruby-identifier">valid_encoding?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-isjis" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
isjis(str) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether input encoding is ISO-2022-JP or not.</p>
<div class="method-source-code" id="isjis-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 174</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">isjis</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-regexp">/\A [\t\n\r\x20-\x7E]*
(?:
(?:\x1b \x28 I [\x21-\x7E]*
|\x1b \x28 J [\x21-\x7E]*
|\x1b \x24 @ (?:[\x21-\x7E]{2})*
|\x1b \x24 B (?:[\x21-\x7E]{2})*
|\x1b \x24 \x28 D (?:[\x21-\x7E]{2})*
)*
\x1b \x28 B [\t\n\r\x20-\x7E]*
)*
\z/nox</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">'BINARY'</span>) <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-issjis" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
issjis(str) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether input encoding is Shift_JIS or not.</p>
<div class="method-source-code" id="issjis-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 165</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">issjis</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-constant">SJIS</span>).<span class="ruby-identifier">valid_encoding?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-isutf8" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
isutf8(str) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether input encoding is UTF-8 or not.</p>
<div class="method-source-code" id="isutf8-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 193</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">isutf8</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-constant">UTF8</span>).<span class="ruby-identifier">valid_encoding?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-kconv" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
kconv(str, to_enc, from_enc=nil)
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to <code>to_enc</code>. <code>to_enc</code> and <code>from_enc</code> are given as constants of <a href="Kconv.html"><code>Kconv</code></a> or <a href="Encoding.html"><code>Encoding</code></a> objects.</p>
<div class="method-source-code" id="kconv-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 57</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-identifier">to_enc</span>, <span class="ruby-identifier">from_enc</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">opt</span> = <span class="ruby-string">''</span>
<span class="ruby-identifier">opt</span> <span class="ruby-operator">+=</span> <span class="ruby-string">' --ic='</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">from_enc</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">from_enc</span>
<span class="ruby-identifier">opt</span> <span class="ruby-operator">+=</span> <span class="ruby-string">' --oc='</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">to_enc</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">to_enc</span>
<span class="ruby-operator">::</span><span class="ruby-constant">NKF</span><span class="ruby-operator">::</span><span class="ruby-identifier">nkf</span>(<span class="ruby-identifier">opt</span>, <span class="ruby-identifier">str</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-toeuc" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
toeuc(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to EUC-JP</p>
<div class="method-source-code" id="toeuc-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 83</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toeuc</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">EUC</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-tojis" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
tojis(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to ISO-2022-JP</p>
<div class="method-source-code" id="tojis-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 74</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tojis</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">JIS</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-tolocale" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
tolocale → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>self</code> to locale encoding</p>
<div class="method-source-code" id="tolocale-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 128</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tolocale</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">locale_charmap</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-tosjis" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
tosjis(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to Shift_JIS</p>
<div class="method-source-code" id="tosjis-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tosjis</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">SJIS</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-toutf16" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
toutf16(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to UTF-16</p>
<div class="method-source-code" id="toutf16-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 110</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toutf16</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">UTF16</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-toutf32" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
toutf32(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to UTF-32</p>
<div class="method-source-code" id="toutf32-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 119</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toutf32</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">UTF32</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-toutf8" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
toutf8(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to UTF-8</p>
<div class="method-source-code" id="toutf8-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 101</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toutf8</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">UTF8</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-guess" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
guess(str) → encoding
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Guess input encoding by <a href="NKF.html#method-c-guess"><code>NKF.guess</code></a></p>
<div class="method-source-code" id="guess-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 141</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">guess</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-operator">::</span><span class="ruby-constant">NKF</span><span class="ruby-operator">::</span><span class="ruby-identifier">guess</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-iseuc" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
iseuc(str) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether input encoding is EUC-JP or not.</p>
<p><strong>Note</strong> don't expect this return value is <a href="MatchData.html"><code>MatchData</code></a>.</p>
<div class="method-source-code" id="iseuc-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 156</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">iseuc</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-constant">EUC</span>).<span class="ruby-identifier">valid_encoding?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-isjis" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
isjis(str) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether input encoding is ISO-2022-JP or not.</p>
<div class="method-source-code" id="isjis-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 174</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">isjis</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-regexp">/\A [\t\n\r\x20-\x7E]*
(?:
(?:\x1b \x28 I [\x21-\x7E]*
|\x1b \x28 J [\x21-\x7E]*
|\x1b \x24 @ (?:[\x21-\x7E]{2})*
|\x1b \x24 B (?:[\x21-\x7E]{2})*
|\x1b \x24 \x28 D (?:[\x21-\x7E]{2})*
)*
\x1b \x28 B [\t\n\r\x20-\x7E]*
)*
\z/nox</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">'BINARY'</span>) <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-issjis" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
issjis(str) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether input encoding is Shift_JIS or not.</p>
<div class="method-source-code" id="issjis-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 165</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">issjis</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-constant">SJIS</span>).<span class="ruby-identifier">valid_encoding?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-isutf8" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
isutf8(str) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether input encoding is UTF-8 or not.</p>
<div class="method-source-code" id="isutf8-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 193</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">isutf8</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-constant">UTF8</span>).<span class="ruby-identifier">valid_encoding?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-kconv" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
kconv(str, to_enc, from_enc=nil)
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to <code>to_enc</code>. <code>to_enc</code> and <code>from_enc</code> are given as constants of <a href="Kconv.html"><code>Kconv</code></a> or <a href="Encoding.html"><code>Encoding</code></a> objects.</p>
<div class="method-source-code" id="kconv-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 57</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-identifier">to_enc</span>, <span class="ruby-identifier">from_enc</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">opt</span> = <span class="ruby-string">''</span>
<span class="ruby-identifier">opt</span> <span class="ruby-operator">+=</span> <span class="ruby-string">' --ic='</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">from_enc</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">from_enc</span>
<span class="ruby-identifier">opt</span> <span class="ruby-operator">+=</span> <span class="ruby-string">' --oc='</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">to_enc</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">to_enc</span>
<span class="ruby-operator">::</span><span class="ruby-constant">NKF</span><span class="ruby-operator">::</span><span class="ruby-identifier">nkf</span>(<span class="ruby-identifier">opt</span>, <span class="ruby-identifier">str</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-toeuc" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
toeuc(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to EUC-JP</p>
<div class="method-source-code" id="toeuc-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 83</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toeuc</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">EUC</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tojis" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
tojis(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to ISO-2022-JP</p>
<div class="method-source-code" id="tojis-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 74</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tojis</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">JIS</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tolocale" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
tolocale → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>self</code> to locale encoding</p>
<div class="method-source-code" id="tolocale-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 128</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tolocale</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">locale_charmap</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tosjis" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
tosjis(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to Shift_JIS</p>
<div class="method-source-code" id="tosjis-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tosjis</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">SJIS</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-toutf16" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
toutf16(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to UTF-16</p>
<div class="method-source-code" id="toutf16-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 110</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toutf16</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">UTF16</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-toutf32" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
toutf32(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to UTF-32</p>
<div class="method-source-code" id="toutf32-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 119</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toutf32</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">UTF32</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-toutf8" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
toutf8(str) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>str</code> to UTF-8</p>
<div class="method-source-code" id="toutf8-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 101</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toutf8</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">kconv</span>(<span class="ruby-identifier">str</span>, <span class="ruby-constant">UTF8</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>