File: C:/Ruby27-x64/share/doc/ruby/html/String.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class String - 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="Object.html">Object</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Comparable.html">Comparable</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-try_convert">::try_convert</a>
<li ><a href="#method-i-25">#%</a>
<li ><a href="#method-i-2A">#*</a>
<li ><a href="#method-i-2B">#+</a>
<li ><a href="#method-i-2B-40">#+@</a>
<li ><a href="#method-i-2D-40">#-@</a>
<li ><a href="#method-i-3C-3C">#<<</a>
<li ><a href="#method-i-3C-3D-3E">#<=></a>
<li ><a href="#method-i-3D-3D">#==</a>
<li ><a href="#method-i-3D-3D-3D">#===</a>
<li ><a href="#method-i-3D~">#=~</a>
<li ><a href="#method-i-5B-5D">#[]</a>
<li ><a href="#method-i-5B-5D-3D">#[]=</a>
<li ><a href="#method-i-ascii_only-3F">#ascii_only?</a>
<li ><a href="#method-i-b">#b</a>
<li ><a href="#method-i-bytes">#bytes</a>
<li ><a href="#method-i-bytesize">#bytesize</a>
<li ><a href="#method-i-byteslice">#byteslice</a>
<li ><a href="#method-i-capitalize">#capitalize</a>
<li ><a href="#method-i-capitalize-21">#capitalize!</a>
<li ><a href="#method-i-casecmp">#casecmp</a>
<li ><a href="#method-i-casecmp-3F">#casecmp?</a>
<li ><a href="#method-i-center">#center</a>
<li ><a href="#method-i-chars">#chars</a>
<li ><a href="#method-i-chomp">#chomp</a>
<li ><a href="#method-i-chomp-21">#chomp!</a>
<li ><a href="#method-i-chop">#chop</a>
<li ><a href="#method-i-chop-21">#chop!</a>
<li ><a href="#method-i-chr">#chr</a>
<li ><a href="#method-i-clear">#clear</a>
<li ><a href="#method-i-codepoints">#codepoints</a>
<li ><a href="#method-i-concat">#concat</a>
<li ><a href="#method-i-count">#count</a>
<li ><a href="#method-i-crypt">#crypt</a>
<li ><a href="#method-i-delete">#delete</a>
<li ><a href="#method-i-delete-21">#delete!</a>
<li ><a href="#method-i-delete_prefix">#delete_prefix</a>
<li ><a href="#method-i-delete_prefix-21">#delete_prefix!</a>
<li ><a href="#method-i-delete_suffix">#delete_suffix</a>
<li ><a href="#method-i-delete_suffix-21">#delete_suffix!</a>
<li ><a href="#method-i-downcase">#downcase</a>
<li ><a href="#method-i-downcase-21">#downcase!</a>
<li ><a href="#method-i-dump">#dump</a>
<li ><a href="#method-i-each_byte">#each_byte</a>
<li ><a href="#method-i-each_char">#each_char</a>
<li ><a href="#method-i-each_codepoint">#each_codepoint</a>
<li ><a href="#method-i-each_grapheme_cluster">#each_grapheme_cluster</a>
<li ><a href="#method-i-each_line">#each_line</a>
<li ><a href="#method-i-empty-3F">#empty?</a>
<li ><a href="#method-i-encode">#encode</a>
<li ><a href="#method-i-encode-21">#encode!</a>
<li ><a href="#method-i-encoding">#encoding</a>
<li ><a href="#method-i-end_with-3F">#end_with?</a>
<li ><a href="#method-i-eql-3F">#eql?</a>
<li ><a href="#method-i-force_encoding">#force_encoding</a>
<li ><a href="#method-i-freeze">#freeze</a>
<li ><a href="#method-i-getbyte">#getbyte</a>
<li ><a href="#method-i-grapheme_clusters">#grapheme_clusters</a>
<li ><a href="#method-i-gsub">#gsub</a>
<li ><a href="#method-i-gsub-21">#gsub!</a>
<li ><a href="#method-i-hash">#hash</a>
<li ><a href="#method-i-hex">#hex</a>
<li ><a href="#method-i-include-3F">#include?</a>
<li ><a href="#method-i-index">#index</a>
<li ><a href="#method-i-initialize_copy">#initialize_copy</a>
<li ><a href="#method-i-insert">#insert</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-intern">#intern</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-length">#length</a>
<li ><a href="#method-i-lines">#lines</a>
<li ><a href="#method-i-ljust">#ljust</a>
<li ><a href="#method-i-lstrip">#lstrip</a>
<li ><a href="#method-i-lstrip-21">#lstrip!</a>
<li ><a href="#method-i-match">#match</a>
<li ><a href="#method-i-match-3F">#match?</a>
<li ><a href="#method-i-next">#next</a>
<li ><a href="#method-i-next-21">#next!</a>
<li ><a href="#method-i-oct">#oct</a>
<li ><a href="#method-i-ord">#ord</a>
<li ><a href="#method-i-partition">#partition</a>
<li ><a href="#method-i-prepend">#prepend</a>
<li ><a href="#method-i-replace">#replace</a>
<li ><a href="#method-i-reverse">#reverse</a>
<li ><a href="#method-i-reverse-21">#reverse!</a>
<li ><a href="#method-i-rindex">#rindex</a>
<li ><a href="#method-i-rjust">#rjust</a>
<li ><a href="#method-i-rpartition">#rpartition</a>
<li ><a href="#method-i-rstrip">#rstrip</a>
<li ><a href="#method-i-rstrip-21">#rstrip!</a>
<li ><a href="#method-i-scan">#scan</a>
<li ><a href="#method-i-scrub">#scrub</a>
<li ><a href="#method-i-scrub-21">#scrub!</a>
<li ><a href="#method-i-setbyte">#setbyte</a>
<li ><a href="#method-i-shellescape">#shellescape</a>
<li ><a href="#method-i-shellsplit">#shellsplit</a>
<li ><a href="#method-i-size">#size</a>
<li ><a href="#method-i-slice">#slice</a>
<li ><a href="#method-i-slice-21">#slice!</a>
<li ><a href="#method-i-split">#split</a>
<li ><a href="#method-i-squeeze">#squeeze</a>
<li ><a href="#method-i-squeeze-21">#squeeze!</a>
<li ><a href="#method-i-start_with-3F">#start_with?</a>
<li ><a href="#method-i-strip">#strip</a>
<li ><a href="#method-i-strip-21">#strip!</a>
<li ><a href="#method-i-sub">#sub</a>
<li ><a href="#method-i-sub-21">#sub!</a>
<li ><a href="#method-i-succ">#succ</a>
<li ><a href="#method-i-succ-21">#succ!</a>
<li ><a href="#method-i-sum">#sum</a>
<li ><a href="#method-i-swapcase">#swapcase</a>
<li ><a href="#method-i-swapcase-21">#swapcase!</a>
<li ><a href="#method-i-to_c">#to_c</a>
<li ><a href="#method-i-to_d">#to_d</a>
<li ><a href="#method-i-to_f">#to_f</a>
<li ><a href="#method-i-to_i">#to_i</a>
<li ><a href="#method-i-to_r">#to_r</a>
<li ><a href="#method-i-to_s">#to_s</a>
<li ><a href="#method-i-to_str">#to_str</a>
<li ><a href="#method-i-to_sym">#to_sym</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>
<li ><a href="#method-i-tr">#tr</a>
<li ><a href="#method-i-tr-21">#tr!</a>
<li ><a href="#method-i-tr_s">#tr_s</a>
<li ><a href="#method-i-tr_s-21">#tr_s!</a>
<li ><a href="#method-i-undump">#undump</a>
<li ><a href="#method-i-unicode_normalize">#unicode_normalize</a>
<li ><a href="#method-i-unicode_normalize-21">#unicode_normalize!</a>
<li ><a href="#method-i-unicode_normalized-3F">#unicode_normalized?</a>
<li ><a href="#method-i-unpack">#unpack</a>
<li ><a href="#method-i-unpack1">#unpack1</a>
<li ><a href="#method-i-upcase">#upcase</a>
<li ><a href="#method-i-upcase-21">#upcase!</a>
<li ><a href="#method-i-upto">#upto</a>
<li ><a href="#method-i-valid_encoding-3F">#valid_encoding?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-String">
<h1 id="class-String" class="class">
class String
</h1>
<section class="description">
<p>A <a href="String.html"><code>String</code></a> object holds and manipulates an arbitrary sequence of bytes, typically representing characters. <a href="String.html"><code>String</code></a> objects may be created using <a href="String.html#method-c-new"><code>String::new</code></a> or as literals.</p>
<p>Because of aliasing issues, users of strings should be aware of the methods that modify the contents of a <a href="String.html"><code>String</code></a> object. Typically, methods with names ending in “!'' modify their receiver, while those without a “!'' return a new <a href="String.html"><code>String</code></a>. However, there are exceptions, such as <a href="String.html#method-i-5B-5D-3D"><code>String#[]=</code></a>.</p>
</section>
<section id="5Buntitled-5D" class="documentation-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-callseq">
new(str="") → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
new(str="", encoding: enc) → new_str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
new(str="", capacity: size) → new_str
</span>
</div>
<div class="method-description">
<p>Returns a new string object containing a copy of <em>str</em>.</p>
<p>The optional <em>encoding</em> keyword argument specifies the encoding of the new string. If not specified, the encoding of <em>str</em> is used (or ASCII-8BIT, if <em>str</em> is not specified).</p>
<p>The optional <em>capacity</em> keyword argument specifies the size of the internal buffer. This may improve performance, when the string will be concatenated many times (causing many realloc calls).</p>
<div class="method-source-code" id="new-source">
<pre>static VALUE
rb_str_init(int argc, VALUE *argv, VALUE str)
{
static ID keyword_ids[2];
VALUE orig, opt, venc, vcapa;
VALUE kwargs[2];
rb_encoding *enc = 0;
int n;
if (!keyword_ids[0]) {
keyword_ids[0] = rb_id_encoding();
CONST_ID(keyword_ids[1], "capacity");
}
n = rb_scan_args(argc, argv, "01:", &orig, &opt);
if (!NIL_P(opt)) {
rb_get_kwargs(opt, keyword_ids, 0, 2, kwargs);
venc = kwargs[0];
vcapa = kwargs[1];
if (venc != Qundef && !NIL_P(venc)) {
enc = rb_to_encoding(venc);
}
if (vcapa != Qundef && !NIL_P(vcapa)) {
long capa = NUM2LONG(vcapa);
long len = 0;
int termlen = enc ? rb_enc_mbminlen(enc) : 1;
if (capa < STR_BUF_MIN_SIZE) {
capa = STR_BUF_MIN_SIZE;
}
if (n == 1) {
StringValue(orig);
len = RSTRING_LEN(orig);
if (capa < len) {
capa = len;
}
if (orig == str) n = 0;
}
str_modifiable(str);
if (STR_EMBED_P(str)) { /* make noembed always */
char *new_ptr = ALLOC_N(char, (size_t)capa + termlen);
memcpy(new_ptr, RSTRING(str)->as.ary, RSTRING_EMBED_LEN_MAX + 1);
RSTRING(str)->as.heap.ptr = new_ptr;
}
else if (FL_TEST(str, STR_SHARED|STR_NOFREE)) {
const size_t size = (size_t)capa + termlen;
const char *const old_ptr = RSTRING_PTR(str);
const size_t osize = RSTRING(str)->as.heap.len + TERM_LEN(str);
char *new_ptr = ALLOC_N(char, (size_t)capa + termlen);
memcpy(new_ptr, old_ptr, osize < size ? osize : size);
FL_UNSET_RAW(str, STR_SHARED|STR_NOFREE);
RSTRING(str)->as.heap.ptr = new_ptr;
}
else if (STR_HEAP_SIZE(str) != (size_t)capa + termlen) {
SIZED_REALLOC_N(RSTRING(str)->as.heap.ptr, char,
(size_t)capa + termlen, STR_HEAP_SIZE(str));
}
RSTRING(str)->as.heap.len = len;
TERM_FILL(&RSTRING(str)->as.heap.ptr[len], termlen);
if (n == 1) {
memcpy(RSTRING(str)->as.heap.ptr, RSTRING_PTR(orig), len);
rb_enc_cr_str_exact_copy(str, orig);
}
FL_SET(str, STR_NOEMBED);
RSTRING(str)->as.heap.aux.capa = capa;
}
else if (n == 1) {
rb_str_replace(str, orig);
}
if (enc) {
rb_enc_associate(str, enc);
ENC_CODERANGE_CLEAR(str);
}
}
else if (n == 1) {
rb_str_replace(str, orig);
}
return str;
}</pre>
</div>
</div>
</div>
<div id="method-c-try_convert" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
try_convert(obj) → string or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Try to convert <em>obj</em> into a <a href="String.html"><code>String</code></a>, using <a href="String.html#method-i-to_str"><code>to_str</code></a> method. Returns converted string or nil if <em>obj</em> cannot be converted for any reason.</p>
<pre class="ruby"><span class="ruby-constant">String</span>.<span class="ruby-identifier">try_convert</span>(<span class="ruby-string">"str"</span>) <span class="ruby-comment">#=> "str"</span>
<span class="ruby-constant">String</span>.<span class="ruby-identifier">try_convert</span>(<span class="ruby-regexp">/re/</span>) <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="try_convert-source">
<pre>static VALUE
rb_str_s_try_convert(VALUE dummy, VALUE str)
{
return rb_check_string_type(str);
}</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-25" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
str % arg → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Format—Uses <em>str</em> as a format specification, and returns the result of applying it to <em>arg</em>. If the format specification contains more than one substitution, then <em>arg</em> must be an <a href="Array.html"><code>Array</code></a> or <a href="Hash.html"><code>Hash</code></a> containing the values to be substituted. See <a href="Kernel.html#method-i-sprintf"><code>Kernel#sprintf</code></a> for details of the format string.</p>
<pre class="ruby"><span class="ruby-string">"%05d"</span> <span class="ruby-operator">%</span> <span class="ruby-value">123</span> <span class="ruby-comment">#=> "00123"</span>
<span class="ruby-string">"%-5s: %016x"</span> <span class="ruby-operator">%</span> [ <span class="ruby-string">"ID"</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">object_id</span> ] <span class="ruby-comment">#=> "ID : 00002b054ec93168"</span>
<span class="ruby-string">"foo = %{foo}"</span> <span class="ruby-operator">%</span> { <span class="ruby-value">:foo</span> <span class="ruby-operator">=></span> <span class="ruby-string">'bar'</span> } <span class="ruby-comment">#=> "foo = bar"</span>
</pre>
<div class="method-source-code" id="25-source">
<pre>static VALUE
rb_str_format_m(VALUE str, VALUE arg)
{
VALUE tmp = rb_check_array_type(arg);
if (!NIL_P(tmp)) {
return rb_str_format(RARRAY_LENINT(tmp), RARRAY_CONST_PTR(tmp), str);
}
return rb_str_format(1, &arg, str);
}</pre>
</div>
</div>
</div>
<div id="method-i-2A" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
str * integer → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Copy — Returns a new <a href="String.html"><code>String</code></a> containing <code>integer</code> copies of the receiver. <code>integer</code> must be greater than or equal to 0.</p>
<pre class="ruby"><span class="ruby-string">"Ho! "</span> <span class="ruby-operator">*</span> <span class="ruby-value">3</span> <span class="ruby-comment">#=> "Ho! Ho! Ho! "</span>
<span class="ruby-string">"Ho! "</span> <span class="ruby-operator">*</span> <span class="ruby-value">0</span> <span class="ruby-comment">#=> ""</span>
</pre>
<div class="method-source-code" id="2A-source">
<pre>VALUE
rb_str_times(VALUE str, VALUE times)
{
VALUE str2;
long n, len;
char *ptr2;
int termlen;
if (times == INT2FIX(1)) {
return rb_str_dup(str);
}
if (times == INT2FIX(0)) {
str2 = str_alloc(rb_obj_class(str));
rb_enc_copy(str2, str);
return str2;
}
len = NUM2LONG(times);
if (len < 0) {
rb_raise(rb_eArgError, "negative argument");
}
if (RSTRING_LEN(str) == 1 && RSTRING_PTR(str)[0] == 0) {
str2 = str_alloc(rb_obj_class(str));
if (!STR_EMBEDDABLE_P(len, 1)) {
RSTRING(str2)->as.heap.aux.capa = len;
RSTRING(str2)->as.heap.ptr = ZALLOC_N(char, (size_t)len + 1);
STR_SET_NOEMBED(str2);
}
STR_SET_LEN(str2, len);
rb_enc_copy(str2, str);
return str2;
}
if (len && LONG_MAX/len < RSTRING_LEN(str)) {
rb_raise(rb_eArgError, "argument too big");
}
len *= RSTRING_LEN(str);
termlen = TERM_LEN(str);
str2 = str_new0(rb_obj_class(str), 0, len, termlen);
ptr2 = RSTRING_PTR(str2);
if (len) {
n = RSTRING_LEN(str);
memcpy(ptr2, RSTRING_PTR(str), n);
while (n <= len/2) {
memcpy(ptr2 + n, ptr2, n);
n *= 2;
}
memcpy(ptr2 + n, ptr2, len-n);
}
STR_SET_LEN(str2, len);
TERM_FILL(&ptr2[len], termlen);
rb_enc_cr_str_copy_for_substr(str2, str);
return str2;
}</pre>
</div>
</div>
</div>
<div id="method-i-2B" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
str + other_str → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Concatenation—Returns a new <a href="String.html"><code>String</code></a> containing <em>other_str</em> concatenated to <em>str</em>.</p>
<pre class="ruby"><span class="ruby-string">"Hello from "</span> <span class="ruby-operator">+</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-comment">#=> "Hello from main"</span>
</pre>
<div class="method-source-code" id="2B-source">
<pre>VALUE
rb_str_plus(VALUE str1, VALUE str2)
{
VALUE str3;
rb_encoding *enc;
char *ptr1, *ptr2, *ptr3;
long len1, len2;
int termlen;
StringValue(str2);
enc = rb_enc_check_str(str1, str2);
RSTRING_GETMEM(str1, ptr1, len1);
RSTRING_GETMEM(str2, ptr2, len2);
termlen = rb_enc_mbminlen(enc);
if (len1 > LONG_MAX - len2) {
rb_raise(rb_eArgError, "string size too big");
}
str3 = str_new0(rb_cString, 0, len1+len2, termlen);
ptr3 = RSTRING_PTR(str3);
memcpy(ptr3, ptr1, len1);
memcpy(ptr3+len1, ptr2, len2);
TERM_FILL(&ptr3[len1+len2], termlen);
ENCODING_CODERANGE_SET(str3, rb_enc_to_index(enc),
ENC_CODERANGE_AND(ENC_CODERANGE(str1), ENC_CODERANGE(str2)));
RB_GC_GUARD(str1);
RB_GC_GUARD(str2);
return str3;
}</pre>
</div>
</div>
</div>
<div id="method-i-2B-40" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
+str → str (mutable)
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>If the string is frozen, then return duplicated mutable string.</p>
<p>If the string is not frozen, then return the string itself.</p>
<div class="method-source-code" id="2B-40-source">
<pre>static VALUE
str_uplus(VALUE str)
{
if (OBJ_FROZEN(str)) {
return rb_str_dup(str);
}
else {
return str;
}
}</pre>
</div>
</div>
</div>
<div id="method-i-2D-40" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
-str → str (frozen)
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a frozen, possibly pre-existing copy of the string.</p>
<p>The string will be deduplicated as long as it does not have any instance variables set on it.</p>
<div class="method-source-code" id="2D-40-source">
<pre>static VALUE
str_uminus(VALUE str)
{
if (!BARE_STRING_P(str) && !rb_obj_frozen_p(str)) {
str = rb_str_dup(str);
}
return rb_fstring(str);
}</pre>
</div>
</div>
</div>
<div id="method-i-3C-3C" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
str << obj → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str << integer → str
</span>
</div>
<div class="method-description">
<p>Appends the given object to <em>str</em>. If the object is an <a href="Integer.html"><code>Integer</code></a>, it is considered a codepoint and converted to a character before being appended.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-string">"hello "</span>
<span class="ruby-identifier">a</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"world"</span> <span class="ruby-comment">#=> "hello world"</span>
<span class="ruby-identifier">a</span> <span class="ruby-operator"><<</span> <span class="ruby-value">33</span> <span class="ruby-comment">#=> "hello world!"</span>
</pre>
<p>See also <a href="String.html#method-i-concat"><code>String#concat</code></a>, which takes multiple arguments.</p>
<div class="method-source-code" id="3C-3C-source">
<pre>VALUE
rb_str_concat(VALUE str1, VALUE str2)
{
unsigned int code;
rb_encoding *enc = STR_ENC_GET(str1);
int encidx;
if (RB_INTEGER_TYPE_P(str2)) {
if (rb_num_to_uint(str2, &code) == 0) {
}
else if (FIXNUM_P(str2)) {
rb_raise(rb_eRangeError, "%ld out of char range", FIX2LONG(str2));
}
else {
rb_raise(rb_eRangeError, "bignum out of char range");
}
}
else {
return rb_str_append(str1, str2);
}
encidx = rb_enc_to_index(enc);
if (encidx == ENCINDEX_ASCII || encidx == ENCINDEX_US_ASCII) {
/* US-ASCII automatically extended to ASCII-8BIT */
char buf[1];
buf[0] = (char)code;
if (code > 0xFF) {
rb_raise(rb_eRangeError, "%u out of char range", code);
}
rb_str_cat(str1, buf, 1);
if (encidx == ENCINDEX_US_ASCII && code > 127) {
rb_enc_associate_index(str1, ENCINDEX_ASCII);
ENC_CODERANGE_SET(str1, ENC_CODERANGE_VALID);
}
}
else {
long pos = RSTRING_LEN(str1);
int cr = ENC_CODERANGE(str1);
int len;
char *buf;
switch (len = rb_enc_codelen(code, enc)) {
case ONIGERR_INVALID_CODE_POINT_VALUE:
rb_raise(rb_eRangeError, "invalid codepoint 0x%X in %s", code, rb_enc_name(enc));
break;
case ONIGERR_TOO_BIG_WIDE_CHAR_VALUE:
case 0:
rb_raise(rb_eRangeError, "%u out of char range", code);
break;
}
buf = ALLOCA_N(char, len + 1);
rb_enc_mbcput(code, buf, enc);
if (rb_enc_precise_mbclen(buf, buf + len + 1, enc) != len) {
rb_raise(rb_eRangeError, "invalid codepoint 0x%X in %s", code, rb_enc_name(enc));
}
rb_str_resize(str1, pos+len);
memcpy(RSTRING_PTR(str1) + pos, buf, len);
if (cr == ENC_CODERANGE_7BIT && code > 127)
cr = ENC_CODERANGE_VALID;
ENC_CODERANGE_SET(str1, cr);
}
return str1;
}</pre>
</div>
</div>
</div>
<div id="method-i-3C-3D-3E" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
string <=> other_string → -1, 0, +1, or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Comparison—Returns -1, 0, +1, or <code>nil</code> depending on whether <code>string</code> is less than, equal to, or greater than <code>other_string</code>.</p>
<p><code>nil</code> is returned if the two values are incomparable.</p>
<p>If the strings are of different lengths, and the strings are equal when compared up to the shortest length, then the longer string is considered greater than the shorter one.</p>
<p><code><=></code> is the basis for the methods <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, and <code>between?</code>, included from module <a href="Comparable.html"><code>Comparable</code></a>. The method String#== does not use Comparable#==.</p>
<pre class="ruby"><span class="ruby-string">"abcdef"</span> <span class="ruby-operator"><=></span> <span class="ruby-string">"abcde"</span> <span class="ruby-comment">#=> 1</span>
<span class="ruby-string">"abcdef"</span> <span class="ruby-operator"><=></span> <span class="ruby-string">"abcdef"</span> <span class="ruby-comment">#=> 0</span>
<span class="ruby-string">"abcdef"</span> <span class="ruby-operator"><=></span> <span class="ruby-string">"abcdefg"</span> <span class="ruby-comment">#=> -1</span>
<span class="ruby-string">"abcdef"</span> <span class="ruby-operator"><=></span> <span class="ruby-string">"ABCDEF"</span> <span class="ruby-comment">#=> 1</span>
<span class="ruby-string">"abcdef"</span> <span class="ruby-operator"><=></span> <span class="ruby-value">1</span> <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="3C-3D-3E-source">
<pre>static VALUE
rb_str_cmp_m(VALUE str1, VALUE str2)
{
int result;
VALUE s = rb_check_string_type(str2);
if (NIL_P(s)) {
return rb_invcmp(str1, str2);
}
result = rb_str_cmp(str1, s);
return INT2FIX(result);
}</pre>
</div>
</div>
</div>
<div id="method-i-3D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
str == obj → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Equality—Returns whether <code>str</code> == <code>obj</code>, similar to Object#==.</p>
<p>If <code>obj</code> is not an instance of <a href="String.html"><code>String</code></a> but responds to <code>to_str</code>, then the two strings are compared using <code>obj.==</code>.</p>
<p>Otherwise, returns similarly to <a href="String.html#method-i-eql-3F"><code>String#eql?</code></a>, comparing length and content.</p>
<div class="method-source-code" id="3D-3D-source">
<pre>VALUE
rb_str_equal(VALUE str1, VALUE str2)
{
if (str1 == str2) return Qtrue;
if (!RB_TYPE_P(str2, T_STRING)) {
if (!rb_respond_to(str2, idTo_str)) {
return Qfalse;
}
return rb_equal(str2, str1);
}
return rb_str_eql_internal(str1, str2);
}</pre>
</div>
</div>
</div>
<div id="method-i-3D-3D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
str === obj → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Equality—Returns whether <code>str</code> == <code>obj</code>, similar to Object#==.</p>
<p>If <code>obj</code> is not an instance of <a href="String.html"><code>String</code></a> but responds to <code>to_str</code>, then the two strings are compared using <code>obj.==</code>.</p>
<p>Otherwise, returns similarly to <a href="String.html#method-i-eql-3F"><code>String#eql?</code></a>, comparing length and content.</p>
<div class="method-source-code" id="3D-3D-3D-source">
<pre>VALUE
rb_str_equal(VALUE str1, VALUE str2)
{
if (str1 == str2) return Qtrue;
if (!RB_TYPE_P(str2, T_STRING)) {
if (!rb_respond_to(str2, idTo_str)) {
return Qfalse;
}
return rb_equal(str2, str1);
}
return rb_str_eql_internal(str1, str2);
}</pre>
</div>
</div>
</div>
<div id="method-i-3D~" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
str =~ obj → integer or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Match—If <em>obj</em> is a <a href="Regexp.html"><code>Regexp</code></a>, use it as a pattern to match against <em>str</em>,and returns the position the match starts, or <code>nil</code> if there is no match. Otherwise, invokes <em>obj.=~</em>, passing <em>str</em> as an argument. The default <code>=~</code> in <a href="Object.html"><code>Object</code></a> returns <code>nil</code>.</p>
<p>Note: <code>str =~ regexp</code> is not the same as <code>regexp =~ str</code>. Strings captured from named capture groups are assigned to local variables only in the second case.</p>
<pre class="ruby"><span class="ruby-string">"cat o' 9 tails"</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\d/</span> <span class="ruby-comment">#=> 7</span>
<span class="ruby-string">"cat o' 9 tails"</span> <span class="ruby-operator">=~</span> <span class="ruby-value">9</span> <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="3D~-source">
<pre>static VALUE
rb_str_match(VALUE x, VALUE y)
{
if (SPECIAL_CONST_P(y)) goto generic;
switch (BUILTIN_TYPE(y)) {
case T_STRING:
rb_raise(rb_eTypeError, "type mismatch: String given");
case T_REGEXP:
return rb_reg_match(y, x);
generic:
default:
return rb_funcall(y, idEqTilde, 1, x);
}
}</pre>
</div>
</div>
</div>
<div id="method-i-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
str[index] → new_str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[start, length] → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[range] → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[regexp] → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[regexp, capture] → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[match_str] → new_str or nil
</span>
</div>
<div class="method-description">
<p>Element Reference — If passed a single <code>index</code>, returns a substring of one character at that index. If passed a <code>start</code> index and a <code>length</code>, returns a substring containing <code>length</code> characters starting at the <code>start</code> index. If passed a <code>range</code>, its beginning and end are interpreted as offsets delimiting the substring to be returned.</p>
<p>In these three cases, if an index is negative, it is counted from the end of the string. For the <code>start</code> and <code>range</code> cases the starting index is just before a character and an index matching the string's size. Additionally, an empty string is returned when the starting index for a character range is at the end of the string.</p>
<p>Returns <code>nil</code> if the initial index falls outside the string or the length is negative.</p>
<p>If a <code>Regexp</code> is supplied, the matching portion of the string is returned. If a <code>capture</code> follows the regular expression, which may be a capture group index or name, follows the regular expression that component of the <a href="MatchData.html"><code>MatchData</code></a> is returned instead.</p>
<p>If a <code>match_str</code> is given, that string is returned if it occurs in the string.</p>
<p>Returns <code>nil</code> if the regular expression does not match or the match string cannot be found.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-string">"hello there"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">1</span>] <span class="ruby-comment">#=> "e"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">2</span>, <span class="ruby-value">3</span>] <span class="ruby-comment">#=> "llo"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">2</span><span class="ruby-operator">..</span><span class="ruby-value">3</span>] <span class="ruby-comment">#=> "ll"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">-3</span>, <span class="ruby-value">2</span>] <span class="ruby-comment">#=> "er"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">7</span><span class="ruby-operator">..</span><span class="ruby-value">-2</span>] <span class="ruby-comment">#=> "her"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">-4</span><span class="ruby-operator">..</span><span class="ruby-value">-2</span>] <span class="ruby-comment">#=> "her"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">-2</span><span class="ruby-operator">..</span><span class="ruby-value">-4</span>] <span class="ruby-comment">#=> ""</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">11</span>, <span class="ruby-value">0</span>] <span class="ruby-comment">#=> ""</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">11</span>] <span class="ruby-comment">#=> nil</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">12</span>, <span class="ruby-value">0</span>] <span class="ruby-comment">#=> nil</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">12</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] <span class="ruby-comment">#=> nil</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/[aeiou](.)\1/</span>] <span class="ruby-comment">#=> "ell"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/[aeiou](.)\1/</span>, <span class="ruby-value">0</span>] <span class="ruby-comment">#=> "ell"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/[aeiou](.)\1/</span>, <span class="ruby-value">1</span>] <span class="ruby-comment">#=> "l"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/[aeiou](.)\1/</span>, <span class="ruby-value">2</span>] <span class="ruby-comment">#=> nil</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/(?<vowel>[aeiou])(?<non_vowel>[^aeiou])/</span>, <span class="ruby-string">"non_vowel"</span>] <span class="ruby-comment">#=> "l"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/(?<vowel>[aeiou])(?<non_vowel>[^aeiou])/</span>, <span class="ruby-string">"vowel"</span>] <span class="ruby-comment">#=> "e"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-string">"lo"</span>] <span class="ruby-comment">#=> "lo"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-string">"bye"</span>] <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="5B-5D-source">
<pre>static VALUE
rb_str_aref_m(int argc, VALUE *argv, VALUE str)
{
if (argc == 2) {
if (RB_TYPE_P(argv[0], T_REGEXP)) {
return rb_str_subpat(str, argv[0], argv[1]);
}
else {
long beg = NUM2LONG(argv[0]);
long len = NUM2LONG(argv[1]);
return rb_str_substr(str, beg, len);
}
}
rb_check_arity(argc, 1, 2);
return rb_str_aref(str, argv[0]);
}</pre>
</div>
</div>
</div>
<div id="method-i-5B-5D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
str[integer] = new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[integer, integer] = new_str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[range] = aString
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[regexp] = new_str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[regexp, integer] = new_str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[regexp, name] = new_str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
str[other_str] = new_str
</span>
</div>
<div class="method-description">
<p>Element Assignment—Replaces some or all of the content of <em>str</em>. The portion of the string affected is determined using the same criteria as <a href="String.html#method-i-5B-5D"><code>String#[]</code></a>. If the replacement string is not the same length as the text it is replacing, the string will be adjusted accordingly. If the regular expression or string is used as the index doesn't match a position in the string, <a href="IndexError.html"><code>IndexError</code></a> is raised. If the regular expression form is used, the optional second <a href="Integer.html"><code>Integer</code></a> allows you to specify which portion of the match to replace (effectively using the <a href="MatchData.html"><code>MatchData</code></a> indexing rules. The forms that take an <a href="Integer.html"><code>Integer</code></a> will raise an <a href="IndexError.html"><code>IndexError</code></a> if the value is out of range; the <a href="Range.html"><code>Range</code></a> form will raise a <a href="RangeError.html"><code>RangeError</code></a>, and the <a href="Regexp.html"><code>Regexp</code></a> and <a href="String.html"><code>String</code></a> will raise an <a href="IndexError.html"><code>IndexError</code></a> on negative match.</p>
<div class="method-source-code" id="5B-5D-3D-source">
<pre>static VALUE
rb_str_aset_m(int argc, VALUE *argv, VALUE str)
{
if (argc == 3) {
if (RB_TYPE_P(argv[0], T_REGEXP)) {
rb_str_subpat_set(str, argv[0], argv[1], argv[2]);
}
else {
rb_str_splice(str, NUM2LONG(argv[0]), NUM2LONG(argv[1]), argv[2]);
}
return argv[2];
}
rb_check_arity(argc, 2, 3);
return rb_str_aset(str, argv[0], argv[1]);
}</pre>
</div>
</div>
</div>
<div id="method-i-ascii_only-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
ascii_only? → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true for a string which has only ASCII characters.</p>
<pre class="ruby"><span class="ruby-string">"abc"</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">"UTF-8"</span>).<span class="ruby-identifier">ascii_only?</span> <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"abc\u{6666}"</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">"UTF-8"</span>).<span class="ruby-identifier">ascii_only?</span> <span class="ruby-comment">#=> false</span>
</pre>
<div class="method-source-code" id="ascii_only-3F-source">
<pre>static VALUE
rb_str_is_ascii_only_p(VALUE str)
{
int cr = rb_enc_str_coderange(str);
return cr == ENC_CODERANGE_7BIT ? Qtrue : Qfalse;
}</pre>
</div>
</div>
</div>
<div id="method-i-b" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
b → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a copied string whose encoding is ASCII-8BIT.</p>
<div class="method-source-code" id="b-source">
<pre>static VALUE
rb_str_b(VALUE str)
{
VALUE str2 = str_alloc(rb_cString);
str_replace_shared_without_enc(str2, str);
ENC_CODERANGE_CLEAR(str2);
return str2;
}</pre>
</div>
</div>
</div>
<div id="method-i-bytes" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
bytes → an_array
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an array of bytes in <em>str</em>. This is a shorthand for <code>str.each_byte.to_a</code>.</p>
<p>If a block is given, which is a deprecated form, works the same as <code>each_byte</code>.</p>
<div class="method-source-code" id="bytes-source">
<pre>static VALUE
rb_str_bytes(VALUE str)
{
VALUE ary = WANTARRAY("bytes", RSTRING_LEN(str));
return rb_str_enumerate_bytes(str, ary);
}</pre>
</div>
</div>
</div>
<div id="method-i-bytesize" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
bytesize → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the length of <code>str</code> in bytes.</p>
<pre class="ruby"><span class="ruby-string">"\x80\u3042"</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-comment">#=> 4</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-comment">#=> 5</span>
</pre>
<div class="method-source-code" id="bytesize-source">
<pre>static VALUE
rb_str_bytesize(VALUE str)
{
return LONG2NUM(RSTRING_LEN(str));
}</pre>
</div>
</div>
</div>
<div id="method-i-byteslice" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
byteslice(integer) → new_str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
byteslice(integer, integer) → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
byteslice(range) → new_str or nil
</span>
</div>
<div class="method-description">
<p>Byte Reference—If passed a single <a href="Integer.html"><code>Integer</code></a>, returns a substring of one byte at that position. If passed two <a href="Integer.html"><code>Integer</code></a> objects, returns a substring starting at the offset given by the first, and a length given by the second. If given a <a href="Range.html"><code>Range</code></a>, a substring containing bytes at offsets given by the range is returned. In all three cases, if an offset is negative, it is counted from the end of <em>str</em>. Returns <code>nil</code> if the initial offset falls outside the string, the length is negative, or the beginning of the range is greater than the end. The encoding of the resulted string keeps original encoding.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">byteslice</span>(<span class="ruby-value">1</span>) <span class="ruby-comment">#=> "e"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">byteslice</span>(<span class="ruby-value">-1</span>) <span class="ruby-comment">#=> "o"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">byteslice</span>(<span class="ruby-value">1</span>, <span class="ruby-value">2</span>) <span class="ruby-comment">#=> "el"</span>
<span class="ruby-string">"\x80\u3042"</span>.<span class="ruby-identifier">byteslice</span>(<span class="ruby-value">1</span>, <span class="ruby-value">3</span>) <span class="ruby-comment">#=> "\u3042"</span>
<span class="ruby-string">"\x03\u3042\xff"</span>.<span class="ruby-identifier">byteslice</span>(<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">3</span>) <span class="ruby-comment">#=> "\u3042"</span>
</pre>
<div class="method-source-code" id="byteslice-source">
<pre>static VALUE
rb_str_byteslice(int argc, VALUE *argv, VALUE str)
{
if (argc == 2) {
long beg = NUM2LONG(argv[0]);
long end = NUM2LONG(argv[1]);
return str_byte_substr(str, beg, end, TRUE);
}
rb_check_arity(argc, 1, 2);
return str_byte_aref(str, argv[0]);
}</pre>
</div>
</div>
</div>
<div id="method-i-capitalize" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
capitalize → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
capitalize([options]) → new_str
</span>
</div>
<div class="method-description">
<p>Returns a copy of <em>str</em> with the first character converted to uppercase and the remainder to lowercase.</p>
<p>See <a href="String.html#method-i-downcase"><code>String#downcase</code></a> for meaning of <code>options</code> and use with different encodings.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">capitalize</span> <span class="ruby-comment">#=> "Hello"</span>
<span class="ruby-string">"HELLO"</span>.<span class="ruby-identifier">capitalize</span> <span class="ruby-comment">#=> "Hello"</span>
<span class="ruby-string">"123ABC"</span>.<span class="ruby-identifier">capitalize</span> <span class="ruby-comment">#=> "123abc"</span>
</pre>
<div class="method-source-code" id="capitalize-source">
<pre>static VALUE
rb_str_capitalize(int argc, VALUE *argv, VALUE str)
{
rb_encoding *enc;
OnigCaseFoldType flags = ONIGENC_CASE_UPCASE | ONIGENC_CASE_TITLECASE;
VALUE ret;
flags = check_case_options(argc, argv, flags);
enc = str_true_enc(str);
if (RSTRING_LEN(str) == 0 || !RSTRING_PTR(str)) return str;
if (flags&ONIGENC_CASE_ASCII_ONLY) {
ret = rb_str_new_with_class(str, 0, RSTRING_LEN(str));
rb_str_ascii_casemap(str, ret, &flags, enc);
}
else {
ret = rb_str_casemap(str, &flags, enc);
}
return ret;
}</pre>
</div>
</div>
</div>
<div id="method-i-capitalize-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
capitalize! → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
capitalize!([options]) → str or nil
</span>
</div>
<div class="method-description">
<p>Modifies <em>str</em> by converting the first character to uppercase and the remainder to lowercase. Returns <code>nil</code> if no changes are made. There is an exception for modern Georgian (mkhedruli/MTAVRULI), where the result is the same as for <a href="String.html#method-i-downcase"><code>String#downcase</code></a>, to avoid mixed case.</p>
<p>See <a href="String.html#method-i-downcase"><code>String#downcase</code></a> for meaning of <code>options</code> and use with different encodings.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-string">"hello"</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">capitalize!</span> <span class="ruby-comment">#=> "Hello"</span>
<span class="ruby-identifier">a</span> <span class="ruby-comment">#=> "Hello"</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">capitalize!</span> <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="capitalize-21-source">
<pre>static VALUE
rb_str_capitalize_bang(int argc, VALUE *argv, VALUE str)
{
rb_encoding *enc;
OnigCaseFoldType flags = ONIGENC_CASE_UPCASE | ONIGENC_CASE_TITLECASE;
flags = check_case_options(argc, argv, flags);
str_modify_keep_cr(str);
enc = str_true_enc(str);
if (RSTRING_LEN(str) == 0 || !RSTRING_PTR(str)) return Qnil;
if (flags&ONIGENC_CASE_ASCII_ONLY)
rb_str_ascii_casemap(str, str, &flags, enc);
else
str_shared_replace(str, rb_str_casemap(str, &flags, enc));
if (ONIGENC_CASE_MODIFIED&flags) return str;
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-casecmp" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
casecmp(other_str) → -1, 0, +1, or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Case-insensitive version of String#<=>. Currently, case-insensitivity only works on characters A-Z/a-z, not all of Unicode. This is different from <a href="String.html#method-i-casecmp-3F"><code>String#casecmp?</code></a>.</p>
<pre class="ruby"><span class="ruby-string">"aBcDeF"</span>.<span class="ruby-identifier">casecmp</span>(<span class="ruby-string">"abcde"</span>) <span class="ruby-comment">#=> 1</span>
<span class="ruby-string">"aBcDeF"</span>.<span class="ruby-identifier">casecmp</span>(<span class="ruby-string">"abcdef"</span>) <span class="ruby-comment">#=> 0</span>
<span class="ruby-string">"aBcDeF"</span>.<span class="ruby-identifier">casecmp</span>(<span class="ruby-string">"abcdefg"</span>) <span class="ruby-comment">#=> -1</span>
<span class="ruby-string">"abcdef"</span>.<span class="ruby-identifier">casecmp</span>(<span class="ruby-string">"ABCDEF"</span>) <span class="ruby-comment">#=> 0</span>
</pre>
<p><code>nil</code> is returned if the two strings have incompatible encodings, or if <code>other_str</code> is not a string.</p>
<pre class="ruby"><span class="ruby-string">"foo"</span>.<span class="ruby-identifier">casecmp</span>(<span class="ruby-value">2</span>) <span class="ruby-comment">#=> nil</span>
<span class="ruby-string">"\u{e4 f6 fc}"</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-string">"ISO-8859-1"</span>).<span class="ruby-identifier">casecmp</span>(<span class="ruby-string">"\u{c4 d6 dc}"</span>) <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="casecmp-source">
<pre>static VALUE
rb_str_casecmp(VALUE str1, VALUE str2)
{
VALUE s = rb_check_string_type(str2);
if (NIL_P(s)) {
return Qnil;
}
return str_casecmp(str1, s);
}</pre>
</div>
</div>
</div>
<div id="method-i-casecmp-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
casecmp?(other_str) → true, false, or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if <code>str</code> and <code>other_str</code> are equal after Unicode case folding, <code>false</code> if they are not equal.</p>
<pre class="ruby"><span class="ruby-string">"aBcDeF"</span>.<span class="ruby-identifier">casecmp?</span>(<span class="ruby-string">"abcde"</span>) <span class="ruby-comment">#=> false</span>
<span class="ruby-string">"aBcDeF"</span>.<span class="ruby-identifier">casecmp?</span>(<span class="ruby-string">"abcdef"</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"aBcDeF"</span>.<span class="ruby-identifier">casecmp?</span>(<span class="ruby-string">"abcdefg"</span>) <span class="ruby-comment">#=> false</span>
<span class="ruby-string">"abcdef"</span>.<span class="ruby-identifier">casecmp?</span>(<span class="ruby-string">"ABCDEF"</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"\u{e4 f6 fc}"</span>.<span class="ruby-identifier">casecmp?</span>(<span class="ruby-string">"\u{c4 d6 dc}"</span>) <span class="ruby-comment">#=> true</span>
</pre>
<p><code>nil</code> is returned if the two strings have incompatible encodings, or if <code>other_str</code> is not a string.</p>
<pre class="ruby"><span class="ruby-string">"foo"</span>.<span class="ruby-identifier">casecmp?</span>(<span class="ruby-value">2</span>) <span class="ruby-comment">#=> nil</span>
<span class="ruby-string">"\u{e4 f6 fc}"</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-string">"ISO-8859-1"</span>).<span class="ruby-identifier">casecmp?</span>(<span class="ruby-string">"\u{c4 d6 dc}"</span>) <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="casecmp-3F-source">
<pre>static VALUE
rb_str_casecmp_p(VALUE str1, VALUE str2)
{
VALUE s = rb_check_string_type(str2);
if (NIL_P(s)) {
return Qnil;
}
return str_casecmp_p(str1, s);
}</pre>
</div>
</div>
</div>
<div id="method-i-center" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
center(width, padstr=' ') → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Centers <code>str</code> in <code>width</code>. If <code>width</code> is greater than the length of <code>str</code>, returns a new <a href="String.html"><code>String</code></a> of length <code>width</code> with <code>str</code> centered and padded with <code>padstr</code>; otherwise, returns <code>str</code>.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">center</span>(<span class="ruby-value">4</span>) <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">center</span>(<span class="ruby-value">20</span>) <span class="ruby-comment">#=> " hello "</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">center</span>(<span class="ruby-value">20</span>, <span class="ruby-string">'123'</span>) <span class="ruby-comment">#=> "1231231hello12312312"</span>
</pre>
<div class="method-source-code" id="center-source">
<pre>static VALUE
rb_str_center(int argc, VALUE *argv, VALUE str)
{
return rb_str_justify(argc, argv, str, 'c');
}</pre>
</div>
</div>
</div>
<div id="method-i-chars" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
chars → an_array
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an array of characters in <em>str</em>. This is a shorthand for <code>str.each_char.to_a</code>.</p>
<p>If a block is given, which is a deprecated form, works the same as <code>each_char</code>.</p>
<div class="method-source-code" id="chars-source">
<pre>static VALUE
rb_str_chars(VALUE str)
{
VALUE ary = WANTARRAY("chars", rb_str_strlen(str));
return rb_str_enumerate_chars(str, ary);
}</pre>
</div>
</div>
</div>
<div id="method-i-chomp" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
chomp(separator=$/) → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a new <a href="String.html"><code>String</code></a> with the given record separator removed from the end of <em>str</em> (if present). If <code>$/</code> has not been changed from the default Ruby record separator, then <code>chomp</code> also removes carriage return characters (that is it will remove <code>\n</code>, <code>\r</code>, and <code>\r\n</code>). If <code>$/</code> is an empty string, it will remove all trailing newlines from the string.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">chomp</span> <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-string">"hello\n"</span>.<span class="ruby-identifier">chomp</span> <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-string">"hello\r\n"</span>.<span class="ruby-identifier">chomp</span> <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-string">"hello\n\r"</span>.<span class="ruby-identifier">chomp</span> <span class="ruby-comment">#=> "hello\n"</span>
<span class="ruby-string">"hello\r"</span>.<span class="ruby-identifier">chomp</span> <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-string">"hello \n there"</span>.<span class="ruby-identifier">chomp</span> <span class="ruby-comment">#=> "hello \n there"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">chomp</span>(<span class="ruby-string">"llo"</span>) <span class="ruby-comment">#=> "he"</span>
<span class="ruby-string">"hello\r\n\r\n"</span>.<span class="ruby-identifier">chomp</span>(<span class="ruby-string">''</span>) <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-string">"hello\r\n\r\r\n"</span>.<span class="ruby-identifier">chomp</span>(<span class="ruby-string">''</span>) <span class="ruby-comment">#=> "hello\r\n\r"</span>
</pre>
<div class="method-source-code" id="chomp-source">
<pre>static VALUE
rb_str_chomp(int argc, VALUE *argv, VALUE str)
{
VALUE rs = chomp_rs(argc, argv);
if (NIL_P(rs)) return rb_str_dup(str);
return rb_str_subseq(str, 0, chompped_length(str, rs));
}</pre>
</div>
</div>
</div>
<div id="method-i-chomp-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
chomp!(separator=$/) → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Modifies <em>str</em> in place as described for <a href="String.html#method-i-chomp"><code>String#chomp</code></a>, returning <em>str</em>, or <code>nil</code> if no modifications were made.</p>
<div class="method-source-code" id="chomp-21-source">
<pre>static VALUE
rb_str_chomp_bang(int argc, VALUE *argv, VALUE str)
{
VALUE rs;
str_modifiable(str);
if (RSTRING_LEN(str) == 0) return Qnil;
rs = chomp_rs(argc, argv);
if (NIL_P(rs)) return Qnil;
return rb_str_chomp_string(str, rs);
}</pre>
</div>
</div>
</div>
<div id="method-i-chop" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
chop → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a new <a href="String.html"><code>String</code></a> with the last character removed. If the string ends with <code>\r\n</code>, both characters are removed. Applying <code>chop</code> to an empty string returns an empty string. <a href="String.html#method-i-chomp"><code>String#chomp</code></a> is often a safer alternative, as it leaves the string unchanged if it doesn't end in a record separator.</p>
<pre class="ruby"><span class="ruby-string">"string\r\n"</span>.<span class="ruby-identifier">chop</span> <span class="ruby-comment">#=> "string"</span>
<span class="ruby-string">"string\n\r"</span>.<span class="ruby-identifier">chop</span> <span class="ruby-comment">#=> "string\n"</span>
<span class="ruby-string">"string\n"</span>.<span class="ruby-identifier">chop</span> <span class="ruby-comment">#=> "string"</span>
<span class="ruby-string">"string"</span>.<span class="ruby-identifier">chop</span> <span class="ruby-comment">#=> "strin"</span>
<span class="ruby-string">"x"</span>.<span class="ruby-identifier">chop</span>.<span class="ruby-identifier">chop</span> <span class="ruby-comment">#=> ""</span>
</pre>
<div class="method-source-code" id="chop-source">
<pre>static VALUE
rb_str_chop(VALUE str)
{
return rb_str_subseq(str, 0, chopped_length(str));
}</pre>
</div>
</div>
</div>
<div id="method-i-chop-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
chop! → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Processes <em>str</em> as for <a href="String.html#method-i-chop"><code>String#chop</code></a>, returning <em>str</em>, or <code>nil</code> if <em>str</em> is the empty string. See also <a href="String.html#method-i-chomp-21"><code>String#chomp!</code></a>.</p>
<div class="method-source-code" id="chop-21-source">
<pre>static VALUE
rb_str_chop_bang(VALUE str)
{
str_modify_keep_cr(str);
if (RSTRING_LEN(str) > 0) {
long len;
len = chopped_length(str);
STR_SET_LEN(str, len);
TERM_FILL(&RSTRING_PTR(str)[len], TERM_LEN(str));
if (ENC_CODERANGE(str) != ENC_CODERANGE_7BIT) {
ENC_CODERANGE_CLEAR(str);
}
return str;
}
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-chr" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
chr → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a one-character string at the beginning of the string.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-string">"abcde"</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">chr</span> <span class="ruby-comment">#=> "a"</span>
</pre>
<div class="method-source-code" id="chr-source">
<pre>static VALUE
rb_str_chr(VALUE str)
{
return rb_str_substr(str, 0, 1);
}</pre>
</div>
</div>
</div>
<div id="method-i-clear" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
clear → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Makes string empty.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-string">"abcde"</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">clear</span> <span class="ruby-comment">#=> ""</span>
</pre>
<div class="method-source-code" id="clear-source">
<pre>static VALUE
rb_str_clear(VALUE str)
{
str_discard(str);
STR_SET_EMBED(str);
STR_SET_EMBED_LEN(str, 0);
RSTRING_PTR(str)[0] = 0;
if (rb_enc_asciicompat(STR_ENC_GET(str)))
ENC_CODERANGE_SET(str, ENC_CODERANGE_7BIT);
else
ENC_CODERANGE_SET(str, ENC_CODERANGE_VALID);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-codepoints" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
codepoints → an_array
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an array of the <a href="Integer.html"><code>Integer</code></a> ordinals of the characters in <em>str</em>. This is a shorthand for <code>str.each_codepoint.to_a</code>.</p>
<p>If a block is given, which is a deprecated form, works the same as <code>each_codepoint</code>.</p>
<div class="method-source-code" id="codepoints-source">
<pre>static VALUE
rb_str_codepoints(VALUE str)
{
VALUE ary = WANTARRAY("codepoints", rb_str_strlen(str));
return rb_str_enumerate_codepoints(str, ary);
}</pre>
</div>
</div>
</div>
<div id="method-i-concat" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
concat(obj1, obj2, ...) → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Concatenates the given object(s) to <em>str</em>. If an object is an <a href="Integer.html"><code>Integer</code></a>, it is considered a codepoint and converted to a character before concatenation.</p>
<p><code>concat</code> can take multiple arguments, and all the arguments are concatenated in order.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-string">"hello "</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-string">"world"</span>, <span class="ruby-value">33</span>) <span class="ruby-comment">#=> "hello world!"</span>
<span class="ruby-identifier">a</span> <span class="ruby-comment">#=> "hello world!"</span>
<span class="ruby-identifier">b</span> = <span class="ruby-string">"sn"</span>
<span class="ruby-identifier">b</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-string">"_"</span>, <span class="ruby-identifier">b</span>, <span class="ruby-string">"_"</span>, <span class="ruby-identifier">b</span>) <span class="ruby-comment">#=> "sn_sn_sn"</span>
</pre>
<p>See also <a href="String.html#method-i-3C-3C"><code>String#<<</code></a>, which takes a single argument.</p>
<div class="method-source-code" id="concat-source">
<pre>static VALUE
rb_str_concat_multi(int argc, VALUE *argv, VALUE str)
{
str_modifiable(str);
if (argc == 1) {
return rb_str_concat(str, argv[0]);
}
else if (argc > 1) {
int i;
VALUE arg_str = rb_str_tmp_new(0);
rb_enc_copy(arg_str, str);
for (i = 0; i < argc; i++) {
rb_str_concat(arg_str, argv[i]);
}
rb_str_buf_append(str, arg_str);
}
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-count" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
count([other_str]+) → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Each <code>other_str</code> parameter defines a set of characters to count. The intersection of these sets defines the characters to count in <code>str</code>. Any <code>other_str</code> that starts with a caret <code>^</code> is negated. The sequence <code>c1-c2</code> means all characters between c1 and c2. The backslash character <code>\</code> can be used to escape <code>^</code> or <code>-</code> and is otherwise ignored unless it appears at the end of a sequence or the end of a <code>other_str</code>.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-string">"hello world"</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">count</span> <span class="ruby-string">"lo"</span> <span class="ruby-comment">#=> 5</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">count</span> <span class="ruby-string">"lo"</span>, <span class="ruby-string">"o"</span> <span class="ruby-comment">#=> 2</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">count</span> <span class="ruby-string">"hello"</span>, <span class="ruby-string">"^l"</span> <span class="ruby-comment">#=> 4</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">count</span> <span class="ruby-string">"ej-m"</span> <span class="ruby-comment">#=> 4</span>
<span class="ruby-string">"hello^world"</span>.<span class="ruby-identifier">count</span> <span class="ruby-string">"\\^aeiou"</span> <span class="ruby-comment">#=> 4</span>
<span class="ruby-string">"hello-world"</span>.<span class="ruby-identifier">count</span> <span class="ruby-string">"a\\-eo"</span> <span class="ruby-comment">#=> 4</span>
<span class="ruby-identifier">c</span> = <span class="ruby-string">"hello world\\r\\n"</span>
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">count</span> <span class="ruby-string">"\\"</span> <span class="ruby-comment">#=> 2</span>
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">count</span> <span class="ruby-string">"\\A"</span> <span class="ruby-comment">#=> 0</span>
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">count</span> <span class="ruby-string">"X-\\w"</span> <span class="ruby-comment">#=> 3</span>
</pre>
<div class="method-source-code" id="count-source">
<pre>static VALUE
rb_str_count(int argc, VALUE *argv, VALUE str)
{
char table[TR_TABLE_SIZE];
rb_encoding *enc = 0;
VALUE del = 0, nodel = 0, tstr;
char *s, *send;
int i;
int ascompat;
rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
tstr = argv[0];
StringValue(tstr);
enc = rb_enc_check(str, tstr);
if (argc == 1) {
const char *ptstr;
if (RSTRING_LEN(tstr) == 1 && rb_enc_asciicompat(enc) &&
(ptstr = RSTRING_PTR(tstr),
ONIGENC_IS_ALLOWED_REVERSE_MATCH(enc, (const unsigned char *)ptstr, (const unsigned char *)ptstr+1)) &&
!is_broken_string(str)) {
int n = 0;
int clen;
unsigned char c = rb_enc_codepoint_len(ptstr, ptstr+1, &clen, enc);
s = RSTRING_PTR(str);
if (!s || RSTRING_LEN(str) == 0) return INT2FIX(0);
send = RSTRING_END(str);
while (s < send) {
if (*(unsigned char*)s++ == c) n++;
}
return INT2NUM(n);
}
}
tr_setup_table(tstr, table, TRUE, &del, &nodel, enc);
for (i=1; i<argc; i++) {
tstr = argv[i];
StringValue(tstr);
enc = rb_enc_check(str, tstr);
tr_setup_table(tstr, table, FALSE, &del, &nodel, enc);
}
s = RSTRING_PTR(str);
if (!s || RSTRING_LEN(str) == 0) return INT2FIX(0);
send = RSTRING_END(str);
ascompat = rb_enc_asciicompat(enc);
i = 0;
while (s < send) {
unsigned int c;
if (ascompat && (c = *(unsigned char*)s) < 0x80) {
if (table[c]) {
i++;
}
s++;
}
else {
int clen;
c = rb_enc_codepoint_len(s, send, &clen, enc);
if (tr_find(c, table, del, nodel)) {
i++;
}
s += clen;
}
}
return INT2NUM(i);
}</pre>
</div>
</div>
</div>
<div id="method-i-crypt" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
crypt(salt_str) → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the string generated by calling <code>crypt(3)</code> standard library function with <code>str</code> and <code>salt_str</code>, in this order, as its arguments. Please do not use this method any longer. It is legacy; provided only for backward compatibility with ruby scripts in earlier days. It is bad to use in contemporary programs for several reasons:</p>
<ul><li>
<p>Behaviour of C's <code>crypt(3)</code> depends on the OS it is run. The generated string lacks data portability.</p>
</li><li>
<p>On some OSes such as Mac OS, <code>crypt(3)</code> never fails (i.e. silently ends up in unexpected results).</p>
</li><li>
<p>On some OSes such as Mac OS, <code>crypt(3)</code> is not thread safe.</p>
</li><li>
<p>So-called “traditional” usage of <code>crypt(3)</code> is very very very weak. According to its manpage, Linux's traditional <code>crypt(3)</code> output has only 2**56 variations; too easy to brute force today. And this is the default behaviour.</p>
</li><li>
<p>In order to make things robust some OSes implement so-called “modular” usage. To go through, you have to do a complex build-up of the <code>salt_str</code> parameter, by hand. Failure in generation of a proper salt string tends not to yield any errors; typos in parameters are normally not detectable.</p>
<ul><li>
<p>For instance, in the following example, the second invocation of <a href="String.html#method-i-crypt"><code>String#crypt</code></a> is wrong; it has a typo in “round=” (lacks “s”). However the call does not fail and something unexpected is generated.</p>
<pre class="ruby"><span class="ruby-string">"foo"</span>.<span class="ruby-identifier">crypt</span>(<span class="ruby-string">"$5$rounds=1000$salt$"</span>) <span class="ruby-comment"># OK, proper usage</span>
<span class="ruby-string">"foo"</span>.<span class="ruby-identifier">crypt</span>(<span class="ruby-string">"$5$round=1000$salt$"</span>) <span class="ruby-comment"># Typo not detected</span>
</pre>
</li></ul>
</li><li>
<p>Even in the “modular” mode, some hash functions are considered archaic and no longer recommended at all; for instance module <code>$1$</code> is officially abandoned by its author: see <a href="http://phk.freebsd.dk/sagas/md5crypt_eol.html">phk.freebsd.dk/sagas/md5crypt_eol.html</a> . For another instance module <code>$3$</code> is considered completely broken: see the manpage of FreeBSD.</p>
</li><li>
<p>On some OS such as Mac OS, there is no modular mode. Yet, as written above, <code>crypt(3)</code> on Mac OS never fails. This means even if you build up a proper salt string it generates a traditional DES hash anyways, and there is no way for you to be aware of.</p>
<pre class="ruby"><span class="ruby-string">"foo"</span>.<span class="ruby-identifier">crypt</span>(<span class="ruby-string">"$5$rounds=1000$salt$"</span>) <span class="ruby-comment"># => "$5fNPQMxC5j6."</span>
</pre>
</li></ul>
<p>If for some reason you cannot migrate to other secure contemporary password hashing algorithms, install the string-crypt gem and <code>require 'string/crypt'</code> to continue using it.</p>
<div class="method-source-code" id="crypt-source">
<pre>static VALUE
rb_str_crypt(VALUE str, VALUE salt)
{
#ifdef HAVE_CRYPT_R
VALUE databuf;
struct crypt_data *data;
# define CRYPT_END() ALLOCV_END(databuf)
#else
extern char *crypt(const char *, const char *);
# define CRYPT_END() (void)0
#endif
VALUE result;
const char *s, *saltp;
char *res;
#ifdef BROKEN_CRYPT
char salt_8bit_clean[3];
#endif
StringValue(salt);
mustnot_wchar(str);
mustnot_wchar(salt);
if (RSTRING_LEN(salt) < 2) {
short_salt:
rb_raise(rb_eArgError, "salt too short (need >=2 bytes)");
}
s = StringValueCStr(str);
saltp = RSTRING_PTR(salt);
if (!saltp[0] || !saltp[1]) goto short_salt;
#ifdef BROKEN_CRYPT
if (!ISASCII((unsigned char)saltp[0]) || !ISASCII((unsigned char)saltp[1])) {
salt_8bit_clean[0] = saltp[0] & 0x7f;
salt_8bit_clean[1] = saltp[1] & 0x7f;
salt_8bit_clean[2] = '\0';
saltp = salt_8bit_clean;
}
#endif
#ifdef HAVE_CRYPT_R
data = ALLOCV(databuf, sizeof(struct crypt_data));
# ifdef HAVE_STRUCT_CRYPT_DATA_INITIALIZED
data->initialized = 0;
# endif
res = crypt_r(s, saltp, data);
#else
res = crypt(s, saltp);
#endif
if (!res) {
int err = errno;
CRYPT_END();
rb_syserr_fail(err, "crypt");
}
result = rb_str_new_cstr(res);
CRYPT_END();
return result;
}</pre>
</div>
</div>
</div>
<div id="method-i-delete" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
delete([other_str]+) → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a copy of <em>str</em> with all characters in the intersection of its arguments deleted. Uses the same rules for building the set of characters as <a href="String.html#method-i-count"><code>String#count</code></a>.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete</span> <span class="ruby-string">"l"</span>,<span class="ruby-string">"lo"</span> <span class="ruby-comment">#=> "heo"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete</span> <span class="ruby-string">"lo"</span> <span class="ruby-comment">#=> "he"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete</span> <span class="ruby-string">"aeiou"</span>, <span class="ruby-string">"^e"</span> <span class="ruby-comment">#=> "hell"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete</span> <span class="ruby-string">"ej-m"</span> <span class="ruby-comment">#=> "ho"</span>
</pre>
<div class="method-source-code" id="delete-source">
<pre>static VALUE
rb_str_delete(int argc, VALUE *argv, VALUE str)
{
str = rb_str_dup(str);
rb_str_delete_bang(argc, argv, str);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-delete-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
delete!([other_str]+) → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Performs a <code>delete</code> operation in place, returning <em>str</em>, or <code>nil</code> if <em>str</em> was not modified.</p>
<div class="method-source-code" id="delete-21-source">
<pre>static VALUE
rb_str_delete_bang(int argc, VALUE *argv, VALUE str)
{
char squeez[TR_TABLE_SIZE];
rb_encoding *enc = 0;
char *s, *send, *t;
VALUE del = 0, nodel = 0;
int modify = 0;
int i, ascompat, cr;
if (RSTRING_LEN(str) == 0 || !RSTRING_PTR(str)) return Qnil;
rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
for (i=0; i<argc; i++) {
VALUE s = argv[i];
StringValue(s);
enc = rb_enc_check(str, s);
tr_setup_table(s, squeez, i==0, &del, &nodel, enc);
}
str_modify_keep_cr(str);
ascompat = rb_enc_asciicompat(enc);
s = t = RSTRING_PTR(str);
send = RSTRING_END(str);
cr = ascompat ? ENC_CODERANGE_7BIT : ENC_CODERANGE_VALID;
while (s < send) {
unsigned int c;
int clen;
if (ascompat && (c = *(unsigned char*)s) < 0x80) {
if (squeez[c]) {
modify = 1;
}
else {
if (t != s) *t = c;
t++;
}
s++;
}
else {
c = rb_enc_codepoint_len(s, send, &clen, enc);
if (tr_find(c, squeez, del, nodel)) {
modify = 1;
}
else {
if (t != s) rb_enc_mbcput(c, t, enc);
t += clen;
if (cr == ENC_CODERANGE_7BIT) cr = ENC_CODERANGE_VALID;
}
s += clen;
}
}
TERM_FILL(t, TERM_LEN(str));
STR_SET_LEN(str, t - RSTRING_PTR(str));
ENC_CODERANGE_SET(str, cr);
if (modify) return str;
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-delete_prefix" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
delete_prefix(prefix) → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a copy of <em>str</em> with leading <code>prefix</code> deleted.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete_prefix</span>(<span class="ruby-string">"hel"</span>) <span class="ruby-comment">#=> "lo"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete_prefix</span>(<span class="ruby-string">"llo"</span>) <span class="ruby-comment">#=> "hello"</span>
</pre>
<div class="method-source-code" id="delete_prefix-source">
<pre>static VALUE
rb_str_delete_prefix(VALUE str, VALUE prefix)
{
long prefixlen;
prefixlen = deleted_prefix_length(str, prefix);
if (prefixlen <= 0) return rb_str_dup(str);
return rb_str_subseq(str, prefixlen, RSTRING_LEN(str) - prefixlen);
}</pre>
</div>
</div>
</div>
<div id="method-i-delete_prefix-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
delete_prefix!(prefix) → self or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Deletes leading <code>prefix</code> from <em>str</em>, returning <code>nil</code> if no change was made.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete_prefix!</span>(<span class="ruby-string">"hel"</span>) <span class="ruby-comment">#=> "lo"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete_prefix!</span>(<span class="ruby-string">"llo"</span>) <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="delete_prefix-21-source">
<pre>static VALUE
rb_str_delete_prefix_bang(VALUE str, VALUE prefix)
{
long prefixlen;
str_modify_keep_cr(str);
prefixlen = deleted_prefix_length(str, prefix);
if (prefixlen <= 0) return Qnil;
return rb_str_drop_bytes(str, prefixlen);
}</pre>
</div>
</div>
</div>
<div id="method-i-delete_suffix" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
delete_suffix(suffix) → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a copy of <em>str</em> with trailing <code>suffix</code> deleted.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete_suffix</span>(<span class="ruby-string">"llo"</span>) <span class="ruby-comment">#=> "he"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete_suffix</span>(<span class="ruby-string">"hel"</span>) <span class="ruby-comment">#=> "hello"</span>
</pre>
<div class="method-source-code" id="delete_suffix-source">
<pre>static VALUE
rb_str_delete_suffix(VALUE str, VALUE suffix)
{
long suffixlen;
suffixlen = deleted_suffix_length(str, suffix);
if (suffixlen <= 0) return rb_str_dup(str);
return rb_str_subseq(str, 0, RSTRING_LEN(str) - suffixlen);
}</pre>
</div>
</div>
</div>
<div id="method-i-delete_suffix-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
delete_suffix!(suffix) → self or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Deletes trailing <code>suffix</code> from <em>str</em>, returning <code>nil</code> if no change was made.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete_suffix!</span>(<span class="ruby-string">"llo"</span>) <span class="ruby-comment">#=> "he"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">delete_suffix!</span>(<span class="ruby-string">"hel"</span>) <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="delete_suffix-21-source">
<pre>static VALUE
rb_str_delete_suffix_bang(VALUE str, VALUE suffix)
{
long olen, suffixlen, len;
str_modifiable(str);
suffixlen = deleted_suffix_length(str, suffix);
if (suffixlen <= 0) return Qnil;
olen = RSTRING_LEN(str);
str_modify_keep_cr(str);
len = olen - suffixlen;
STR_SET_LEN(str, len);
TERM_FILL(&RSTRING_PTR(str)[len], TERM_LEN(str));
if (ENC_CODERANGE(str) != ENC_CODERANGE_7BIT) {
ENC_CODERANGE_CLEAR(str);
}
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-downcase" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
downcase → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
downcase([options]) → new_str
</span>
</div>
<div class="method-description">
<p>Returns a copy of <em>str</em> with all uppercase letters replaced with their lowercase counterparts. Which letters exactly are replaced, and by which other letters, depends on the presence or absence of options, and on the <code>encoding</code> of the string.</p>
<p>The meaning of the <code>options</code> is as follows:</p>
<dl class="rdoc-list note-list"><dt>No option
<dd>
<p>Full Unicode case mapping, suitable for most languages (see :turkic and :lithuanian options below for exceptions). Context-dependent case mapping as described in Table 3-14 of the Unicode standard is currently not supported.</p>
</dd><dt>:ascii
<dd>
<p>Only the ASCII region, i.e. the characters “A'' to “Z'' and “a'' to “z'', are affected. This option cannot be combined with any other option.</p>
</dd><dt>:turkic
<dd>
<p>Full Unicode case mapping, adapted for Turkic languages (Turkish, Azerbaijani, …). This means that upper case I is mapped to lower case dotless i, and so on.</p>
</dd><dt>:lithuanian
<dd>
<p>Currently, just full Unicode case mapping. In the future, full Unicode case mapping adapted for Lithuanian (keeping the dot on the lower case i even if there is an accent on top).</p>
</dd><dt>:fold
<dd>
<p>Only available on <code>downcase</code> and <code>downcase!</code>. Unicode case <strong>folding</strong>, which is more far-reaching than Unicode case mapping. This option currently cannot be combined with any other option (i.e. there is currently no variant for turkic languages).</p>
</dd></dl>
<p>Please note that several assumptions that are valid for ASCII-only case conversions do not hold for more general case conversions. For example, the length of the result may not be the same as the length of the input (neither in characters nor in bytes), some roundtrip assumptions (e.g. str.downcase == str.upcase.downcase) may not apply, and Unicode normalization (i.e. <a href="String.html#method-i-unicode_normalize"><code>String#unicode_normalize</code></a>) is not necessarily maintained by case mapping operations.</p>
<p>Non-ASCII case mapping/folding is currently supported for UTF-8, UTF-16BE/LE, UTF-32BE/LE, and ISO-8859-1~16 Strings/Symbols. This support will be extended to other encodings.</p>
<pre class="ruby"><span class="ruby-string">"hEllO"</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-comment">#=> "hello"</span>
</pre>
<div class="method-source-code" id="downcase-source">
<pre>static VALUE
rb_str_downcase(int argc, VALUE *argv, VALUE str)
{
rb_encoding *enc;
OnigCaseFoldType flags = ONIGENC_CASE_DOWNCASE;
VALUE ret;
flags = check_case_options(argc, argv, flags);
enc = str_true_enc(str);
if (case_option_single_p(flags, enc, str)) {
ret = rb_str_new_with_class(str, RSTRING_PTR(str), RSTRING_LEN(str));
str_enc_copy(ret, str);
downcase_single(ret);
}
else if (flags&ONIGENC_CASE_ASCII_ONLY) {
ret = rb_str_new_with_class(str, 0, RSTRING_LEN(str));
rb_str_ascii_casemap(str, ret, &flags, enc);
}
else {
ret = rb_str_casemap(str, &flags, enc);
}
return ret;
}</pre>
</div>
</div>
</div>
<div id="method-i-downcase-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
downcase! → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
downcase!([options]) → str or nil
</span>
</div>
<div class="method-description">
<p>Downcases the contents of <em>str</em>, returning <code>nil</code> if no changes were made.</p>
<p>See <a href="String.html#method-i-downcase"><code>String#downcase</code></a> for meaning of <code>options</code> and use with different encodings.</p>
<div class="method-source-code" id="downcase-21-source">
<pre>static VALUE
rb_str_downcase_bang(int argc, VALUE *argv, VALUE str)
{
rb_encoding *enc;
OnigCaseFoldType flags = ONIGENC_CASE_DOWNCASE;
flags = check_case_options(argc, argv, flags);
str_modify_keep_cr(str);
enc = str_true_enc(str);
if (case_option_single_p(flags, enc, str)) {
if (downcase_single(str))
flags |= ONIGENC_CASE_MODIFIED;
}
else if (flags&ONIGENC_CASE_ASCII_ONLY)
rb_str_ascii_casemap(str, str, &flags, enc);
else
str_shared_replace(str, rb_str_casemap(str, &flags, enc));
if (ONIGENC_CASE_MODIFIED&flags) return str;
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-dump" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
dump → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a quoted version of the string with all non-printing characters replaced by <code>\xHH</code> notation and all special characters escaped.</p>
<p>This method can be used for round-trip: if the resulting <code>new_str</code> is eval'ed, it will produce the original string.</p>
<pre class="ruby"><span class="ruby-string">"hello \n ''"</span>.<span class="ruby-identifier">dump</span> <span class="ruby-comment">#=> "\"hello \\n ''\""</span>
<span class="ruby-string">"\f\x00\xff\\\""</span>.<span class="ruby-identifier">dump</span> <span class="ruby-comment">#=> "\"\\f\\x00\\xFF\\\\\\\"\""</span>
</pre>
<p>See also <a href="String.html#method-i-undump"><code>String#undump</code></a>.</p>
<div class="method-source-code" id="dump-source">
<pre>VALUE
rb_str_dump(VALUE str)
{
int encidx = rb_enc_get_index(str);
rb_encoding *enc = rb_enc_from_index(encidx);
long len;
const char *p, *pend;
char *q, *qend;
VALUE result;
int u8 = (encidx == rb_utf8_encindex());
static const char nonascii_suffix[] = ".dup.force_encoding(\"%s\")";
len = 2; /* "" */
if (!rb_enc_asciicompat(enc)) {
len += strlen(nonascii_suffix) - rb_strlen_lit("%s");
len += strlen(enc->name);
}
p = RSTRING_PTR(str); pend = p + RSTRING_LEN(str);
while (p < pend) {
int clen;
unsigned char c = *p++;
switch (c) {
case '"': case '\\':
case '\n': case '\r':
case '\t': case '\f':
case '\013': case '\010': case '\007': case '\033':
clen = 2;
break;
case '#':
clen = IS_EVSTR(p, pend) ? 2 : 1;
break;
default:
if (ISPRINT(c)) {
clen = 1;
}
else {
if (u8 && c > 0x7F) { /* \u notation */
int n = rb_enc_precise_mbclen(p-1, pend, enc);
if (MBCLEN_CHARFOUND_P(n)) {
unsigned int cc = rb_enc_mbc_to_codepoint(p-1, pend, enc);
if (cc <= 0xFFFF)
clen = 6; /* \uXXXX */
else if (cc <= 0xFFFFF)
clen = 9; /* \u{XXXXX} */
else
clen = 10; /* \u{XXXXXX} */
p += MBCLEN_CHARFOUND_LEN(n)-1;
break;
}
}
clen = 4; /* \xNN */
}
break;
}
if (clen > LONG_MAX - len) {
rb_raise(rb_eRuntimeError, "string size too big");
}
len += clen;
}
result = rb_str_new_with_class(str, 0, len);
p = RSTRING_PTR(str); pend = p + RSTRING_LEN(str);
q = RSTRING_PTR(result); qend = q + len + 1;
*q++ = '"';
while (p < pend) {
unsigned char c = *p++;
if (c == '"' || c == '\\') {
*q++ = '\\';
*q++ = c;
}
else if (c == '#') {
if (IS_EVSTR(p, pend)) *q++ = '\\';
*q++ = '#';
}
else if (c == '\n') {
*q++ = '\\';
*q++ = 'n';
}
else if (c == '\r') {
*q++ = '\\';
*q++ = 'r';
}
else if (c == '\t') {
*q++ = '\\';
*q++ = 't';
}
else if (c == '\f') {
*q++ = '\\';
*q++ = 'f';
}
else if (c == '\013') {
*q++ = '\\';
*q++ = 'v';
}
else if (c == '\010') {
*q++ = '\\';
*q++ = 'b';
}
else if (c == '\007') {
*q++ = '\\';
*q++ = 'a';
}
else if (c == '\033') {
*q++ = '\\';
*q++ = 'e';
}
else if (ISPRINT(c)) {
*q++ = c;
}
else {
*q++ = '\\';
if (u8) {
int n = rb_enc_precise_mbclen(p-1, pend, enc) - 1;
if (MBCLEN_CHARFOUND_P(n)) {
int cc = rb_enc_mbc_to_codepoint(p-1, pend, enc);
p += n;
if (cc <= 0xFFFF)
snprintf(q, qend-q, "u%04X", cc); /* \uXXXX */
else
snprintf(q, qend-q, "u{%X}", cc); /* \u{XXXXX} or \u{XXXXXX} */
q += strlen(q);
continue;
}
}
snprintf(q, qend-q, "x%02X", c);
q += 3;
}
}
*q++ = '"';
*q = '\0';
if (!rb_enc_asciicompat(enc)) {
snprintf(q, qend-q, nonascii_suffix, enc->name);
encidx = rb_ascii8bit_encindex();
}
/* result from dump is ASCII */
rb_enc_associate_index(result, encidx);
ENC_CODERANGE_SET(result, ENC_CODERANGE_7BIT);
return result;
}</pre>
</div>
</div>
</div>
<div id="method-i-each_byte" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
each_byte {|integer| block } → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
each_byte → an_enumerator
</span>
</div>
<div class="method-description">
<p>Passes each byte in <em>str</em> to the given block, or returns an enumerator if no block is given.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">each_byte</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">print</span> <span class="ruby-identifier">c</span>, <span class="ruby-string">' '</span> }
</pre>
<p><em>produces:</em></p>
<pre>104 101 108 108 111</pre>
<div class="method-source-code" id="each_byte-source">
<pre>static VALUE
rb_str_each_byte(VALUE str)
{
RETURN_SIZED_ENUMERATOR(str, 0, 0, rb_str_each_byte_size);
return rb_str_enumerate_bytes(str, 0);
}</pre>
</div>
</div>
</div>
<div id="method-i-each_char" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
each_char {|cstr| block } → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
each_char → an_enumerator
</span>
</div>
<div class="method-description">
<p>Passes each character in <em>str</em> to the given block, or returns an enumerator if no block is given.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">each_char</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">print</span> <span class="ruby-identifier">c</span>, <span class="ruby-string">' '</span> }
</pre>
<p><em>produces:</em></p>
<pre class="ruby"><span class="ruby-identifier">h</span> <span class="ruby-identifier">e</span> <span class="ruby-identifier">l</span> <span class="ruby-identifier">l</span> <span class="ruby-identifier">o</span>
</pre>
<div class="method-source-code" id="each_char-source">
<pre>static VALUE
rb_str_each_char(VALUE str)
{
RETURN_SIZED_ENUMERATOR(str, 0, 0, rb_str_each_char_size);
return rb_str_enumerate_chars(str, 0);
}</pre>
</div>
</div>
</div>
<div id="method-i-each_codepoint" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
each_codepoint {|integer| block } → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
each_codepoint → an_enumerator
</span>
</div>
<div class="method-description">
<p>Passes the <a href="Integer.html"><code>Integer</code></a> ordinal of each character in <em>str</em>, also known as a <em>codepoint</em> when applied to Unicode strings to the given block. For encodings other than UTF-8/UTF-16(BE|LE)/UTF-32(BE|LE), values are directly derived from the binary representation of each character.</p>
<p>If no block is given, an enumerator is returned instead.</p>
<pre class="ruby"><span class="ruby-string">"hello\u0639"</span>.<span class="ruby-identifier">each_codepoint</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">print</span> <span class="ruby-identifier">c</span>, <span class="ruby-string">' '</span> }
</pre>
<p><em>produces:</em></p>
<pre>104 101 108 108 111 1593</pre>
<div class="method-source-code" id="each_codepoint-source">
<pre>static VALUE
rb_str_each_codepoint(VALUE str)
{
RETURN_SIZED_ENUMERATOR(str, 0, 0, rb_str_each_char_size);
return rb_str_enumerate_codepoints(str, 0);
}</pre>
</div>
</div>
</div>
<div id="method-i-each_grapheme_cluster" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
each_grapheme_cluster {|cstr| block } → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
each_grapheme_cluster → an_enumerator
</span>
</div>
<div class="method-description">
<p>Passes each grapheme cluster in <em>str</em> to the given block, or returns an enumerator if no block is given. Unlike <a href="String.html#method-i-each_char"><code>String#each_char</code></a>, this enumerates by grapheme clusters defined by Unicode Standard Annex #29 <a href="http://unicode.org/reports/tr29">unicode.org/reports/tr29</a>/</p>
<pre class="ruby"><span class="ruby-string">"a\u0300"</span>.<span class="ruby-identifier">each_char</span>.<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">size</span> <span class="ruby-comment">#=> 2</span>
<span class="ruby-string">"a\u0300"</span>.<span class="ruby-identifier">each_grapheme_cluster</span>.<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">size</span> <span class="ruby-comment">#=> 1</span>
</pre>
<div class="method-source-code" id="each_grapheme_cluster-source">
<pre>static VALUE
rb_str_each_grapheme_cluster(VALUE str)
{
RETURN_SIZED_ENUMERATOR(str, 0, 0, rb_str_each_grapheme_cluster_size);
return rb_str_enumerate_grapheme_clusters(str, 0);
}</pre>
</div>
</div>
</div>
<div id="method-i-each_line" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
each_line(separator=$/, chomp: false) {|substr| block } → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
each_line(separator=$/, chomp: false) → an_enumerator
</span>
</div>
<div class="method-description">
<p>Splits <em>str</em> using the supplied parameter as the record separator (<code>$/</code> by default), passing each substring in turn to the supplied block. If a zero-length record separator is supplied, the string is split into paragraphs delimited by multiple successive newlines.</p>
<p>If <code>chomp</code> is <code>true</code>, <code>separator</code> will be removed from the end of each line.</p>
<p>If no block is given, an enumerator is returned instead.</p>
<pre class="ruby"><span class="ruby-string">"hello\nworld"</span>.<span class="ruby-identifier">each_line</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span> <span class="ruby-identifier">s</span>}
<span class="ruby-comment"># prints:</span>
<span class="ruby-comment"># "hello\n"</span>
<span class="ruby-comment"># "world"</span>
<span class="ruby-string">"hello\nworld"</span>.<span class="ruby-identifier">each_line</span>(<span class="ruby-string">'l'</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span> <span class="ruby-identifier">s</span>}
<span class="ruby-comment"># prints:</span>
<span class="ruby-comment"># "hel"</span>
<span class="ruby-comment"># "l"</span>
<span class="ruby-comment"># "o\nworl"</span>
<span class="ruby-comment"># "d"</span>
<span class="ruby-string">"hello\n\n\nworld"</span>.<span class="ruby-identifier">each_line</span>(<span class="ruby-string">''</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span> <span class="ruby-identifier">s</span>}
<span class="ruby-comment"># prints</span>
<span class="ruby-comment"># "hello\n\n"</span>
<span class="ruby-comment"># "world"</span>
<span class="ruby-string">"hello\nworld"</span>.<span class="ruby-identifier">each_line</span>(<span class="ruby-value">chomp:</span> <span class="ruby-keyword">true</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span> <span class="ruby-identifier">s</span>}
<span class="ruby-comment"># prints:</span>
<span class="ruby-comment"># "hello"</span>
<span class="ruby-comment"># "world"</span>
<span class="ruby-string">"hello\nworld"</span>.<span class="ruby-identifier">each_line</span>(<span class="ruby-string">'l'</span>, <span class="ruby-value">chomp:</span> <span class="ruby-keyword">true</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span> <span class="ruby-identifier">s</span>}
<span class="ruby-comment"># prints:</span>
<span class="ruby-comment"># "he"</span>
<span class="ruby-comment"># ""</span>
<span class="ruby-comment"># "o\nwor"</span>
<span class="ruby-comment"># "d"</span>
</pre>
<div class="method-source-code" id="each_line-source">
<pre>static VALUE
rb_str_each_line(int argc, VALUE *argv, VALUE str)
{
RETURN_SIZED_ENUMERATOR(str, argc, argv, 0);
return rb_str_enumerate_lines(argc, argv, str, 0);
}</pre>
</div>
</div>
</div>
<div id="method-i-empty-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
empty? → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if <em>str</em> has a length of zero.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-comment">#=> false</span>
<span class="ruby-string">" "</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-comment">#=> false</span>
<span class="ruby-string">""</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-comment">#=> true</span>
</pre>
<div class="method-source-code" id="empty-3F-source">
<pre>static VALUE
rb_str_empty(VALUE str)
{
if (RSTRING_LEN(str) == 0)
return Qtrue;
return Qfalse;
}</pre>
</div>
</div>
</div>
<div id="method-i-encode" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
encode(encoding [, options] ) → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
encode(dst_encoding, src_encoding [, options] ) → str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
encode([options]) → str
</span>
</div>
<div class="method-description">
<p>The first form returns a copy of <code>str</code> transcoded to encoding <code>encoding</code>. The second form returns a copy of <code>str</code> transcoded from src_encoding to dst_encoding. The last form returns a copy of <code>str</code> transcoded to <code>Encoding.default_internal</code>.</p>
<p>By default, the first and second form raise <a href="Encoding/UndefinedConversionError.html"><code>Encoding::UndefinedConversionError</code></a> for characters that are undefined in the destination encoding, and <a href="Encoding/InvalidByteSequenceError.html"><code>Encoding::InvalidByteSequenceError</code></a> for invalid byte sequences in the source encoding. The last form by default does not raise exceptions but uses replacement strings.</p>
<p>The <code>options</code> <a href="Hash.html"><code>Hash</code></a> gives details for conversion and can have the following keys:</p>
<dl class="rdoc-list note-list"><dt>:invalid
<dd>
<p>If the value is <code>:replace</code>, <a href="String.html#method-i-encode"><code>encode</code></a> replaces invalid byte sequences in <code>str</code> with the replacement character. The default is to raise the <a href="Encoding/InvalidByteSequenceError.html"><code>Encoding::InvalidByteSequenceError</code></a> exception</p>
</dd><dt>:undef
<dd>
<p>If the value is <code>:replace</code>, <a href="String.html#method-i-encode"><code>encode</code></a> replaces characters which are undefined in the destination encoding with the replacement character. The default is to raise the <a href="Encoding/UndefinedConversionError.html"><code>Encoding::UndefinedConversionError</code></a>.</p>
</dd><dt>:replace
<dd>
<p>Sets the replacement string to the given value. The default replacement string is “uFFFD” for Unicode encoding forms, and “?” otherwise.</p>
</dd><dt>:fallback
<dd>
<p>Sets the replacement string by the given object for undefined character. The object should be a <a href="Hash.html"><code>Hash</code></a>, a <a href="Proc.html"><code>Proc</code></a>, a <a href="Method.html"><code>Method</code></a>, or an object which has [] method. Its key is an undefined character encoded in the source encoding of current transcoder. Its value can be any encoding until it can be converted into the destination encoding of the transcoder.</p>
</dd><dt>:xml
<dd>
<p>The value must be <code>:text</code> or <code>:attr</code>. If the value is <code>:text</code> <a href="String.html#method-i-encode"><code>encode</code></a> replaces undefined characters with their (upper-case hexadecimal) numeric character references. '&', '<', and '>' are converted to “&amp;”, “&lt;”, and “&gt;”, respectively. If the value is <code>:attr</code>, <a href="String.html#method-i-encode"><code>encode</code></a> also quotes the replacement result (using '“'), and replaces '”' with “&quot;”.</p>
</dd><dt>:cr_newline
<dd>
<p>Replaces LF (“n”) with CR (“r”) if value is true.</p>
</dd><dt>:crlf_newline
<dd>
<p>Replaces LF (“n”) with CRLF (“rn”) if value is true.</p>
</dd><dt>:universal_newline
<dd>
<p>Replaces CRLF (“rn”) and CR (“r”) with LF (“n”) if value is true.</p>
</dd></dl>
<div class="method-source-code" id="encode-source">
<pre>static VALUE
str_encode(int argc, VALUE *argv, VALUE str)
{
VALUE newstr = str;
int encidx = str_transcode(argc, argv, &newstr);
return encoded_dup(newstr, str, encidx);
}</pre>
</div>
</div>
</div>
<div id="method-i-encode-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
encode!(encoding [, options] ) → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
encode!(dst_encoding, src_encoding [, options] ) → str
</span>
</div>
<div class="method-description">
<p>The first form transcodes the contents of <em>str</em> from str.encoding to <code>encoding</code>. The second form transcodes the contents of <em>str</em> from src_encoding to dst_encoding. The options <a href="Hash.html"><code>Hash</code></a> gives details for conversion. See <a href="String.html#method-i-encode"><code>String#encode</code></a> for details. Returns the string even if no changes were made.</p>
<div class="method-source-code" id="encode-21-source">
<pre>static VALUE
str_encode_bang(int argc, VALUE *argv, VALUE str)
{
VALUE newstr;
int encidx;
rb_check_frozen(str);
newstr = str;
encidx = str_transcode(argc, argv, &newstr);
if (encidx < 0) return str;
if (newstr == str) {
rb_enc_associate_index(str, encidx);
return str;
}
rb_str_shared_replace(str, newstr);
return str_encode_associate(str, encidx);
}</pre>
</div>
</div>
</div>
<div id="method-i-encoding" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
encoding → encoding
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the <a href="Encoding.html"><code>Encoding</code></a> object that represents the encoding of obj.</p>
<div class="method-source-code" id="encoding-source">
<pre>VALUE
rb_obj_encoding(VALUE obj)
{
int idx = rb_enc_get_index(obj);
if (idx < 0) {
rb_raise(rb_eTypeError, "unknown encoding");
}
return rb_enc_from_encoding_index(idx & ENC_INDEX_MASK);
}</pre>
</div>
</div>
</div>
<div id="method-i-end_with-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
end_with?([suffixes]+) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if <code>str</code> ends with one of the <code>suffixes</code> given.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-string">"ello"</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-comment"># returns true if one of the +suffixes+ matches.</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-string">"heaven"</span>, <span class="ruby-string">"ello"</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-string">"heaven"</span>, <span class="ruby-string">"paradise"</span>) <span class="ruby-comment">#=> false</span>
</pre>
<div class="method-source-code" id="end_with-3F-source">
<pre>static VALUE
rb_str_end_with(int argc, VALUE *argv, VALUE str)
{
int i;
char *p, *s, *e;
rb_encoding *enc;
for (i=0; i<argc; i++) {
VALUE tmp = argv[i];
StringValue(tmp);
enc = rb_enc_check(str, tmp);
if (RSTRING_LEN(str) < RSTRING_LEN(tmp)) continue;
p = RSTRING_PTR(str);
e = p + RSTRING_LEN(str);
s = e - RSTRING_LEN(tmp);
if (rb_enc_left_char_head(p, s, e, enc) != s)
continue;
if (memcmp(s, RSTRING_PTR(tmp), RSTRING_LEN(tmp)) == 0)
return Qtrue;
}
return Qfalse;
}</pre>
</div>
</div>
</div>
<div id="method-i-eql-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
eql?(other) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Two strings are equal if they have the same length and content.</p>
<div class="method-source-code" id="eql-3F-source">
<pre>MJIT_FUNC_EXPORTED VALUE
rb_str_eql(VALUE str1, VALUE str2)
{
if (str1 == str2) return Qtrue;
if (!RB_TYPE_P(str2, T_STRING)) return Qfalse;
return rb_str_eql_internal(str1, str2);
}</pre>
</div>
</div>
</div>
<div id="method-i-force_encoding" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
force_encoding(encoding) → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Changes the encoding to <code>encoding</code> and returns self.</p>
<div class="method-source-code" id="force_encoding-source">
<pre>static VALUE
rb_str_force_encoding(VALUE str, VALUE enc)
{
str_modifiable(str);
rb_enc_associate(str, rb_to_encoding(enc));
ENC_CODERANGE_CLEAR(str);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-freeze" class="method-detail ">
<div class="method-heading">
<span class="method-name">freeze</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="freeze-source">
<pre>VALUE
rb_str_freeze(VALUE str)
{
if (OBJ_FROZEN(str)) return str;
rb_str_resize(str, RSTRING_LEN(str));
return rb_obj_freeze(str);
}</pre>
</div>
</div>
</div>
<div id="method-i-getbyte" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
getbyte(index) → 0 .. 255
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns the <em>index</em>th byte as an integer.</p>
<div class="method-source-code" id="getbyte-source">
<pre>static VALUE
rb_str_getbyte(VALUE str, VALUE index)
{
long pos = NUM2LONG(index);
if (pos < 0)
pos += RSTRING_LEN(str);
if (pos < 0 || RSTRING_LEN(str) <= pos)
return Qnil;
return INT2FIX((unsigned char)RSTRING_PTR(str)[pos]);
}</pre>
</div>
</div>
</div>
<div id="method-i-grapheme_clusters" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
grapheme_clusters → an_array
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an array of grapheme clusters in <em>str</em>. This is a shorthand for <code>str.each_grapheme_cluster.to_a</code>.</p>
<p>If a block is given, which is a deprecated form, works the same as <code>each_grapheme_cluster</code>.</p>
<div class="method-source-code" id="grapheme_clusters-source">
<pre>static VALUE
rb_str_grapheme_clusters(VALUE str)
{
VALUE ary = WANTARRAY("grapheme_clusters", rb_str_strlen(str));
return rb_str_enumerate_grapheme_clusters(str, ary);
}</pre>
</div>
</div>
</div>
<div id="method-i-gsub" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
gsub(pattern, replacement) → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
gsub(pattern, hash) → new_str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
gsub(pattern) {|match| block } → new_str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
gsub(pattern) → enumerator
</span>
</div>
<div class="method-description">
<p>Returns a copy of <em>str</em> with <em>all</em> occurrences of <em>pattern</em> substituted for the second argument. The <em>pattern</em> is typically a <a href="Regexp.html"><code>Regexp</code></a>; if given as a <a href="String.html"><code>String</code></a>, any regular expression metacharacters it contains will be interpreted literally, e.g. <code>\d</code> will match a backslash followed by 'd', instead of a digit.</p>
<p>If <code>replacement</code> is a <a href="String.html"><code>String</code></a> it will be substituted for the matched text. It may contain back-references to the pattern's capture groups of the form <code>\d</code>, where <em>d</em> is a group number, or <code>\k<n></code>, where <em>n</em> is a group name. Similarly, <code>\&</code>, <code>\'</code>, <code>\`</code>, and <code>+</code> correspond to special variables, <code>$&</code>, <code>$'</code>, <code>$`</code>, and <code>$+</code>, respectively. (See <a href="regexp_rdoc.html">regexp.rdoc</a> for details.) <code>\0</code> is the same as <code>\&</code>. <code>\\</code> is interpreted as an escape, i.e., a single backslash. Note that, within <code>replacement</code> the special match variables, such as <code>$&</code>, will not refer to the current match.</p>
<p>If the second argument is a <a href="Hash.html"><code>Hash</code></a>, and the matched text is one of its keys, the corresponding value is the replacement string.</p>
<p>In the block form, the current match string is passed in as a parameter, and variables such as <code>$1</code>, <code>$2</code>, <code>$`</code>, <code>$&</code>, and <code>$'</code> will be set appropriately. (See <a href="regexp_rdoc.html">regexp.rdoc</a> for details.) The value returned by the block will be substituted for the match on each call.</p>
<p>When neither a block nor a second argument is supplied, an <a href="Enumerator.html"><code>Enumerator</code></a> is returned.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/[aeiou]/</span>, <span class="ruby-string">'*'</span>) <span class="ruby-comment">#=> "h*ll*"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/([aeiou])/</span>, <span class="ruby-string">'<\1>'</span>) <span class="ruby-comment">#=> "h<e>ll<o>"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/./</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">ord</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">' '</span>} <span class="ruby-comment">#=> "104 101 108 108 111 "</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/(?<foo>[aeiou])/</span>, <span class="ruby-string">'{\k<foo>}'</span>) <span class="ruby-comment">#=> "h{e}ll{o}"</span>
<span class="ruby-string">'hello'</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/[eo]/</span>, <span class="ruby-string">'e'</span> <span class="ruby-operator">=></span> <span class="ruby-value">3</span>, <span class="ruby-string">'o'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'*'</span>) <span class="ruby-comment">#=> "h3ll*"</span>
</pre>
<p>Note that a string literal consumes backslashes. (See <a href="syntax/literals_rdoc.html">syntax/literals.rdoc</a> for details on string literals.) Back-references are typically preceded by an additional backslash. For example, if you want to write a back-reference <code>\&</code> in <code>replacement</code> with a double-quoted string literal, you need to write: <code>"..\\&.."</code>. If you want to write a non-back-reference string <code>\&</code> in <code>replacement</code>, you need first to escape the backslash to prevent this method from interpreting it as a back-reference, and then you need to escape the backslashes again to prevent a string literal from consuming them: <code>"..\\\\&.."</code>. You may want to use the block form to avoid a lot of backslashes.</p>
<div class="method-source-code" id="gsub-source">
<pre>static VALUE
rb_str_gsub(int argc, VALUE *argv, VALUE str)
{
return str_gsub(argc, argv, str, 0);
}</pre>
</div>
</div>
</div>
<div id="method-i-gsub-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
gsub!(pattern, replacement) → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
gsub!(pattern, hash) → str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
gsub!(pattern) {|match| block } → str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
gsub!(pattern) → an_enumerator
</span>
</div>
<div class="method-description">
<p>Performs the substitutions of <a href="String.html#method-i-gsub"><code>String#gsub</code></a> in place, returning <em>str</em>, or <code>nil</code> if no substitutions were performed. If no block and no <em>replacement</em> is given, an enumerator is returned instead.</p>
<div class="method-source-code" id="gsub-21-source">
<pre>static VALUE
rb_str_gsub_bang(int argc, VALUE *argv, VALUE str)
{
str_modify_keep_cr(str);
return str_gsub(argc, argv, str, 1);
}</pre>
</div>
</div>
</div>
<div id="method-i-hash" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
hash → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a hash based on the string's length, content and encoding.</p>
<p>See also <a href="Object.html#method-i-hash"><code>Object#hash</code></a>.</p>
<div class="method-source-code" id="hash-source">
<pre>static VALUE
rb_str_hash_m(VALUE str)
{
st_index_t hval = rb_str_hash(str);
return ST2FIX(hval);
}</pre>
</div>
</div>
</div>
<div id="method-i-hex" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
hex → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Treats leading characters from <em>str</em> as a string of hexadecimal digits (with an optional sign and an optional <code>0x</code>) and returns the corresponding number. Zero is returned on error.</p>
<pre class="ruby"><span class="ruby-string">"0x0a"</span>.<span class="ruby-identifier">hex</span> <span class="ruby-comment">#=> 10</span>
<span class="ruby-string">"-1234"</span>.<span class="ruby-identifier">hex</span> <span class="ruby-comment">#=> -4660</span>
<span class="ruby-string">"0"</span>.<span class="ruby-identifier">hex</span> <span class="ruby-comment">#=> 0</span>
<span class="ruby-string">"wombat"</span>.<span class="ruby-identifier">hex</span> <span class="ruby-comment">#=> 0</span>
</pre>
<div class="method-source-code" id="hex-source">
<pre>static VALUE
rb_str_hex(VALUE str)
{
return rb_str_to_inum(str, 16, FALSE);
}</pre>
</div>
</div>
</div>
<div id="method-i-include-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
include? other_str → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if <em>str</em> contains the given string or character.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">include?</span> <span class="ruby-string">"lo"</span> <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">include?</span> <span class="ruby-string">"ol"</span> <span class="ruby-comment">#=> false</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">include?</span> <span class="ruby-value">?h</span> <span class="ruby-comment">#=> true</span>
</pre>
<div class="method-source-code" id="include-3F-source">
<pre>static VALUE
rb_str_include(VALUE str, VALUE arg)
{
long i;
StringValue(arg);
i = rb_str_index(str, arg, 0);
if (i == -1) return Qfalse;
return Qtrue;
}</pre>
</div>
</div>
</div>
<div id="method-i-index" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
index(substring [, offset]) → integer or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
index(regexp [, offset]) → integer or nil
</span>
</div>
<div class="method-description">
<p>Returns the index of the first occurrence of the given <em>substring</em> or pattern (<em>regexp</em>) in <em>str</em>. Returns <code>nil</code> if not found. If the second parameter is present, it specifies the position in the string to begin the search.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">index</span>(<span class="ruby-string">'e'</span>) <span class="ruby-comment">#=> 1</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">index</span>(<span class="ruby-string">'lo'</span>) <span class="ruby-comment">#=> 3</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">index</span>(<span class="ruby-string">'a'</span>) <span class="ruby-comment">#=> nil</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">index</span>(<span class="ruby-value">?e</span>) <span class="ruby-comment">#=> 1</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">index</span>(<span class="ruby-regexp">/[aeiou]/</span>, <span class="ruby-value">-3</span>) <span class="ruby-comment">#=> 4</span>
</pre>
<div class="method-source-code" id="index-source">
<pre>static VALUE
rb_str_index_m(int argc, VALUE *argv, VALUE str)
{
VALUE sub;
VALUE initpos;
long pos;
if (rb_scan_args(argc, argv, "11", &sub, &initpos) == 2) {
pos = NUM2LONG(initpos);
}
else {
pos = 0;
}
if (pos < 0) {
pos += str_strlen(str, NULL);
if (pos < 0) {
if (RB_TYPE_P(sub, T_REGEXP)) {
rb_backref_set(Qnil);
}
return Qnil;
}
}
if (SPECIAL_CONST_P(sub)) goto generic;
switch (BUILTIN_TYPE(sub)) {
case T_REGEXP:
if (pos > str_strlen(str, NULL))
return Qnil;
pos = str_offset(RSTRING_PTR(str), RSTRING_END(str), pos,
rb_enc_check(str, sub), single_byte_optimizable(str));
pos = rb_reg_search(sub, str, pos, 0);
pos = rb_str_sublen(str, pos);
break;
generic:
default: {
VALUE tmp;
tmp = rb_check_string_type(sub);
if (NIL_P(tmp)) {
rb_raise(rb_eTypeError, "type mismatch: %s given",
rb_obj_classname(sub));
}
sub = tmp;
}
/* fall through */
case T_STRING:
pos = rb_str_index(str, sub, pos);
pos = rb_str_sublen(str, pos);
break;
}
if (pos == -1) return Qnil;
return LONG2NUM(pos);
}</pre>
</div>
</div>
</div>
<div id="method-i-initialize_copy" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
replace(other_str) → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Replaces the contents of <em>str</em> with the corresponding values in <em>other_str</em>.</p>
<pre class="ruby"><span class="ruby-identifier">s</span> = <span class="ruby-string">"hello"</span> <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">replace</span> <span class="ruby-string">"world"</span> <span class="ruby-comment">#=> "world"</span>
</pre>
<div class="method-source-code" id="initialize_copy-source">
<pre>VALUE
rb_str_replace(VALUE str, VALUE str2)
{
str_modifiable(str);
if (str == str2) return str;
StringValue(str2);
str_discard(str);
return str_replace(str, str2);
}</pre>
</div>
</div>
</div>
<div id="method-i-insert" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
insert(index, other_str) → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Inserts <em>other_str</em> before the character at the given <em>index</em>, modifying <em>str</em>. Negative indices count from the end of the string, and insert <em>after</em> the given character. The intent is insert <em>aString</em> so that it starts at the given <em>index</em>.</p>
<pre class="ruby"><span class="ruby-string">"abcd"</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-value">0</span>, <span class="ruby-string">'X'</span>) <span class="ruby-comment">#=> "Xabcd"</span>
<span class="ruby-string">"abcd"</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-value">3</span>, <span class="ruby-string">'X'</span>) <span class="ruby-comment">#=> "abcXd"</span>
<span class="ruby-string">"abcd"</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-value">4</span>, <span class="ruby-string">'X'</span>) <span class="ruby-comment">#=> "abcdX"</span>
<span class="ruby-string">"abcd"</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-value">-3</span>, <span class="ruby-string">'X'</span>) <span class="ruby-comment">#=> "abXcd"</span>
<span class="ruby-string">"abcd"</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-value">-1</span>, <span class="ruby-string">'X'</span>) <span class="ruby-comment">#=> "abcdX"</span>
</pre>
<div class="method-source-code" id="insert-source">
<pre>static VALUE
rb_str_insert(VALUE str, VALUE idx, VALUE str2)
{
long pos = NUM2LONG(idx);
if (pos == -1) {
return rb_str_append(str, str2);
}
else if (pos < 0) {
pos++;
}
rb_str_splice(str, pos, 0, str2);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
inspect → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a printable version of <em>str</em>, surrounded by quote marks, with special characters escaped.</p>
<pre class="ruby"><span class="ruby-identifier">str</span> = <span class="ruby-string">"hello"</span>
<span class="ruby-identifier">str</span>[<span class="ruby-value">3</span>] = <span class="ruby-string">"\b"</span>
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">inspect</span> <span class="ruby-comment">#=> "\"hel\\bo\""</span>
</pre>
<div class="method-source-code" id="inspect-source">
<pre>VALUE
rb_str_inspect(VALUE str)
{
int encidx = ENCODING_GET(str);
rb_encoding *enc = rb_enc_from_index(encidx), *actenc;
const char *p, *pend, *prev;
char buf[CHAR_ESC_LEN + 1];
VALUE result = rb_str_buf_new(0);
rb_encoding *resenc = rb_default_internal_encoding();
int unicode_p = rb_enc_unicode_p(enc);
int asciicompat = rb_enc_asciicompat(enc);
if (resenc == NULL) resenc = rb_default_external_encoding();
if (!rb_enc_asciicompat(resenc)) resenc = rb_usascii_encoding();
rb_enc_associate(result, resenc);
str_buf_cat2(result, "\"");
p = RSTRING_PTR(str); pend = RSTRING_END(str);
prev = p;
actenc = get_actual_encoding(encidx, str);
if (actenc != enc) {
enc = actenc;
if (unicode_p) unicode_p = rb_enc_unicode_p(enc);
}
while (p < pend) {
unsigned int c, cc;
int n;
n = rb_enc_precise_mbclen(p, pend, enc);
if (!MBCLEN_CHARFOUND_P(n)) {
if (p > prev) str_buf_cat(result, prev, p - prev);
n = rb_enc_mbminlen(enc);
if (pend < p + n)
n = (int)(pend - p);
while (n--) {
snprintf(buf, CHAR_ESC_LEN, "\\x%02X", *p & 0377);
str_buf_cat(result, buf, strlen(buf));
prev = ++p;
}
continue;
}
n = MBCLEN_CHARFOUND_LEN(n);
c = rb_enc_mbc_to_codepoint(p, pend, enc);
p += n;
if ((asciicompat || unicode_p) &&
(c == '"'|| c == '\\' ||
(c == '#' &&
p < pend &&
MBCLEN_CHARFOUND_P(rb_enc_precise_mbclen(p,pend,enc)) &&
(cc = rb_enc_codepoint(p,pend,enc),
(cc == '$' || cc == '@' || cc == '{'))))) {
if (p - n > prev) str_buf_cat(result, prev, p - n - prev);
str_buf_cat2(result, "\\");
if (asciicompat || enc == resenc) {
prev = p - n;
continue;
}
}
switch (c) {
case '\n': cc = 'n'; break;
case '\r': cc = 'r'; break;
case '\t': cc = 't'; break;
case '\f': cc = 'f'; break;
case '\013': cc = 'v'; break;
case '\010': cc = 'b'; break;
case '\007': cc = 'a'; break;
case 033: cc = 'e'; break;
default: cc = 0; break;
}
if (cc) {
if (p - n > prev) str_buf_cat(result, prev, p - n - prev);
buf[0] = '\\';
buf[1] = (char)cc;
str_buf_cat(result, buf, 2);
prev = p;
continue;
}
if ((enc == resenc && rb_enc_isprint(c, enc)) ||
(asciicompat && rb_enc_isascii(c, enc) && ISPRINT(c))) {
continue;
}
else {
if (p - n > prev) str_buf_cat(result, prev, p - n - prev);
rb_str_buf_cat_escaped_char(result, c, unicode_p);
prev = p;
continue;
}
}
if (p > prev) str_buf_cat(result, prev, p - prev);
str_buf_cat2(result, "\"");
return result;
}</pre>
</div>
</div>
</div>
<div id="method-i-intern" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
intern → symbol
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the <a href="Symbol.html"><code>Symbol</code></a> corresponding to <em>str</em>, creating the symbol if it did not previously exist. See <a href="Symbol.html#method-i-id2name"><code>Symbol#id2name</code></a>.</p>
<pre class="ruby"><span class="ruby-string">"Koala"</span>.<span class="ruby-identifier">intern</span> <span class="ruby-comment">#=> :Koala</span>
<span class="ruby-identifier">s</span> = <span class="ruby-string">'cat'</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-comment">#=> :cat</span>
<span class="ruby-identifier">s</span> <span class="ruby-operator">==</span> <span class="ruby-value">:cat</span> <span class="ruby-comment">#=> true</span>
<span class="ruby-identifier">s</span> = <span class="ruby-string">'@cat'</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-comment">#=> :@cat</span>
<span class="ruby-identifier">s</span> <span class="ruby-operator">==</span> <span class="ruby-value">:@cat</span> <span class="ruby-comment">#=> true</span>
</pre>
<p>This can also be used to create symbols that cannot be represented using the <code>:xxx</code> notation.</p>
<pre class="ruby"><span class="ruby-string">'cat and dog'</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-comment">#=> :"cat and dog"</span>
</pre>
<div class="method-source-code" id="intern-source">
<pre>VALUE
rb_str_intern(VALUE str)
{
#if USE_SYMBOL_GC
rb_encoding *enc, *ascii;
int type;
#else
ID id;
#endif
VALUE sym = lookup_str_sym(str);
if (sym) {
return sym;
}
#if USE_SYMBOL_GC
enc = rb_enc_get(str);
ascii = rb_usascii_encoding();
if (enc != ascii && sym_check_asciionly(str)) {
str = rb_str_dup(str);
rb_enc_associate(str, ascii);
OBJ_FREEZE(str);
enc = ascii;
}
else {
str = rb_str_dup(str);
OBJ_FREEZE(str);
}
str = rb_fstring(str);
type = rb_str_symname_type(str, IDSET_ATTRSET_FOR_INTERN);
if (type < 0) type = ID_JUNK;
return dsymbol_alloc(rb_cSymbol, str, enc, type);
#else
id = intern_str(str, 0);
return ID2SYM(id);
#endif
}</pre>
</div>
</div>
</div>
<div id="method-i-iseuc" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
String#iseuc → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether <code>self</code>'s encoding is EUC-JP or not.</p>
<div class="method-source-code" id="iseuc-source">
<pre><span class="ruby-comment"># File ext/nkf/lib/kconv.rb, line 264</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">iseuc</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">iseuc</span>(<span class="ruby-keyword">self</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">
String#isjis → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether <code>self</code>'s 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 276</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">isjis</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">isjis</span>(<span class="ruby-keyword">self</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">
String#issjis → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether <code>self</code>'s 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 270</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">issjis</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">issjis</span>(<span class="ruby-keyword">self</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">
String#isutf8 → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns whether <code>self</code>'s 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 282</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">isutf8</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">isutf8</span>(<span class="ruby-keyword">self</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">
String#kconv(to_enc, from_enc)
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>self</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 205</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">kconv</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">from_enc</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">encoding</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">from_enc</span> <span class="ruby-operator">&&</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">encoding</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">list</span>[<span class="ruby-value">0</span>]
<span class="ruby-constant">Kconv</span><span class="ruby-operator">::</span><span class="ruby-identifier">kconv</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">to_enc</span>, <span class="ruby-identifier">from_enc</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-length" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
length → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the character length of <em>str</em>.</p>
<div class="method-source-code" id="length-source">
<pre>VALUE
rb_str_length(VALUE str)
{
return LONG2NUM(str_strlen(str, NULL));
}</pre>
</div>
</div>
</div>
<div id="method-i-lines" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
lines(separator=$/, chomp: false) → an_array
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an array of lines in <em>str</em> split using the supplied record separator (<code>$/</code> by default). This is a shorthand for <code>str.each_line(separator, getline_args).to_a</code>.</p>
<p>If <code>chomp</code> is <code>true</code>, <code>separator</code> will be removed from the end of each line.</p>
<pre class="ruby"><span class="ruby-string">"hello\nworld\n"</span>.<span class="ruby-identifier">lines</span> <span class="ruby-comment">#=> ["hello\n", "world\n"]</span>
<span class="ruby-string">"hello world"</span>.<span class="ruby-identifier">lines</span>(<span class="ruby-string">' '</span>) <span class="ruby-comment">#=> ["hello ", " ", "world"]</span>
<span class="ruby-string">"hello\nworld\n"</span>.<span class="ruby-identifier">lines</span>(<span class="ruby-value">chomp:</span> <span class="ruby-keyword">true</span>) <span class="ruby-comment">#=> ["hello", "world"]</span>
</pre>
<p>If a block is given, which is a deprecated form, works the same as <code>each_line</code>.</p>
<div class="method-source-code" id="lines-source">
<pre>static VALUE
rb_str_lines(int argc, VALUE *argv, VALUE str)
{
VALUE ary = WANTARRAY("lines", 0);
return rb_str_enumerate_lines(argc, argv, str, ary);
}</pre>
</div>
</div>
</div>
<div id="method-i-ljust" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
ljust(integer, padstr=' ') → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>If <em>integer</em> is greater than the length of <em>str</em>, returns a new <a href="String.html"><code>String</code></a> of length <em>integer</em> with <em>str</em> left justified and padded with <em>padstr</em>; otherwise, returns <em>str</em>.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">ljust</span>(<span class="ruby-value">4</span>) <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">ljust</span>(<span class="ruby-value">20</span>) <span class="ruby-comment">#=> "hello "</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">ljust</span>(<span class="ruby-value">20</span>, <span class="ruby-string">'1234'</span>) <span class="ruby-comment">#=> "hello123412341234123"</span>
</pre>
<div class="method-source-code" id="ljust-source">
<pre>static VALUE
rb_str_ljust(int argc, VALUE *argv, VALUE str)
{
return rb_str_justify(argc, argv, str, 'l');
}</pre>
</div>
</div>
</div>
<div id="method-i-lstrip" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
lstrip → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a copy of the receiver with leading whitespace removed. See also <a href="String.html#method-i-rstrip"><code>String#rstrip</code></a> and <a href="String.html#method-i-strip"><code>String#strip</code></a>.</p>
<p>Refer to <a href="String.html#method-i-strip"><code>String#strip</code></a> for the definition of whitespace.</p>
<pre class="ruby"><span class="ruby-string">" hello "</span>.<span class="ruby-identifier">lstrip</span> <span class="ruby-comment">#=> "hello "</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">lstrip</span> <span class="ruby-comment">#=> "hello"</span>
</pre>
<div class="method-source-code" id="lstrip-source">
<pre>static VALUE
rb_str_lstrip(VALUE str)
{
char *start;
long len, loffset;
RSTRING_GETMEM(str, start, len);
loffset = lstrip_offset(str, start, start+len, STR_ENC_GET(str));
if (loffset <= 0) return rb_str_dup(str);
return rb_str_subseq(str, loffset, len - loffset);
}</pre>
</div>
</div>
</div>
<div id="method-i-lstrip-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
lstrip! → self or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes leading whitespace from the receiver. Returns the altered receiver, or <code>nil</code> if no change was made. See also <a href="String.html#method-i-rstrip-21"><code>String#rstrip!</code></a> and <a href="String.html#method-i-strip-21"><code>String#strip!</code></a>.</p>
<p>Refer to <a href="String.html#method-i-strip"><code>String#strip</code></a> for the definition of whitespace.</p>
<pre class="ruby"><span class="ruby-string">" hello "</span>.<span class="ruby-identifier">lstrip!</span> <span class="ruby-comment">#=> "hello "</span>
<span class="ruby-string">"hello "</span>.<span class="ruby-identifier">lstrip!</span> <span class="ruby-comment">#=> nil</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">lstrip!</span> <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="lstrip-21-source">
<pre>static VALUE
rb_str_lstrip_bang(VALUE str)
{
rb_encoding *enc;
char *start, *s;
long olen, loffset;
str_modify_keep_cr(str);
enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, start, olen);
loffset = lstrip_offset(str, start, start+olen, enc);
if (loffset > 0) {
long len = olen-loffset;
s = start + loffset;
memmove(start, s, len);
STR_SET_LEN(str, len);
#if !SHARABLE_MIDDLE_SUBSTRING
TERM_FILL(start+len, rb_enc_mbminlen(enc));
#endif
return str;
}
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-match" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
match(pattern) → matchdata or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
match(pattern, pos) → matchdata or nil
</span>
</div>
<div class="method-description">
<p>Converts <em>pattern</em> to a <a href="Regexp.html"><code>Regexp</code></a> (if it isn't already one), then invokes its <code>match</code> method on <em>str</em>. If the second parameter is present, it specifies the position in the string to begin the search.</p>
<pre class="ruby"><span class="ruby-string">'hello'</span>.<span class="ruby-identifier">match</span>(<span class="ruby-string">'(.)\1'</span>) <span class="ruby-comment">#=> #<MatchData "ll" 1:"l"></span>
<span class="ruby-string">'hello'</span>.<span class="ruby-identifier">match</span>(<span class="ruby-string">'(.)\1'</span>)[<span class="ruby-value">0</span>] <span class="ruby-comment">#=> "ll"</span>
<span class="ruby-string">'hello'</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">/(.)\1/</span>)[<span class="ruby-value">0</span>] <span class="ruby-comment">#=> "ll"</span>
<span class="ruby-string">'hello'</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">/(.)\1/</span>, <span class="ruby-value">3</span>) <span class="ruby-comment">#=> nil</span>
<span class="ruby-string">'hello'</span>.<span class="ruby-identifier">match</span>(<span class="ruby-string">'xx'</span>) <span class="ruby-comment">#=> nil</span>
</pre>
<p>If a block is given, invoke the block with <a href="MatchData.html"><code>MatchData</code></a> if match succeed, so that you can write</p>
<pre>str.match(pat) {|m| ...}</pre>
<p>instead of</p>
<pre>if m = str.match(pat)
...
end</pre>
<p>The return value is a value from block execution in this case.</p>
<div class="method-source-code" id="match-source">
<pre>static VALUE
rb_str_match_m(int argc, VALUE *argv, VALUE str)
{
VALUE re, result;
if (argc < 1)
rb_check_arity(argc, 1, 2);
re = argv[0];
argv[0] = str;
result = rb_funcallv(get_pat(re), rb_intern("match"), argc, argv);
if (!NIL_P(result) && rb_block_given_p()) {
return rb_yield(result);
}
return result;
}</pre>
</div>
</div>
</div>
<div id="method-i-match-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
match?(pattern) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
match?(pattern, pos) → true or false
</span>
</div>
<div class="method-description">
<p>Converts <em>pattern</em> to a <code>Regexp</code> (if it isn't already one), then returns a <code>true</code> or <code>false</code> indicates whether the regexp is matched <em>str</em> or not without updating <code>$~</code> and other related variables. If the second parameter is present, it specifies the position in the string to begin the search.</p>
<pre class="ruby"><span class="ruby-string">"Ruby"</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-regexp">/R.../</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"Ruby"</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-regexp">/R.../</span>, <span class="ruby-value">1</span>) <span class="ruby-comment">#=> false</span>
<span class="ruby-string">"Ruby"</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-regexp">/P.../</span>) <span class="ruby-comment">#=> false</span>
<span class="ruby-node">$&</span> <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="match-3F-source">
<pre>static VALUE
rb_str_match_m_p(int argc, VALUE *argv, VALUE str)
{
VALUE re;
rb_check_arity(argc, 1, 2);
re = get_pat(argv[0]);
return rb_reg_match_p(re, str, argc > 1 ? NUM2LONG(argv[1]) : 0);
}</pre>
</div>
</div>
</div>
<div id="method-i-next" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
next → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the successor to <em>str</em>. The successor is calculated by incrementing characters starting from the rightmost alphanumeric (or the rightmost character if there are no alphanumerics) in the string. Incrementing a digit always results in another digit, and incrementing a letter results in another letter of the same case. Incrementing nonalphanumerics uses the underlying character set's collating sequence.</p>
<p>If the increment generates a “carry,'' the character to the left of it is incremented. This process repeats until there is no carry, adding an additional character if necessary.</p>
<pre class="ruby"><span class="ruby-string">"abcd"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "abce"</span>
<span class="ruby-string">"THX1138"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "THX1139"</span>
<span class="ruby-string">"<<koala>>"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "<<koalb>>"</span>
<span class="ruby-string">"1999zzz"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "2000aaa"</span>
<span class="ruby-string">"ZZZ9999"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "AAAA0000"</span>
<span class="ruby-string">"***"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "**+"</span>
</pre>
<div class="method-source-code" id="next-source">
<pre>VALUE
rb_str_succ(VALUE orig)
{
VALUE str;
str = rb_str_new_with_class(orig, RSTRING_PTR(orig), RSTRING_LEN(orig));
rb_enc_cr_str_copy_for_substr(str, orig);
return str_succ(str);
}</pre>
</div>
</div>
</div>
<div id="method-i-next-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
next! → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Equivalent to <a href="String.html#method-i-succ"><code>String#succ</code></a>, but modifies the receiver in place.</p>
<div class="method-source-code" id="next-21-source">
<pre>static VALUE
rb_str_succ_bang(VALUE str)
{
rb_str_modify(str);
str_succ(str);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-oct" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
oct → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Treats leading characters of <em>str</em> as a string of octal digits (with an optional sign) and returns the corresponding number. Returns 0 if the conversion fails.</p>
<pre class="ruby"><span class="ruby-string">"123"</span>.<span class="ruby-identifier">oct</span> <span class="ruby-comment">#=> 83</span>
<span class="ruby-string">"-377"</span>.<span class="ruby-identifier">oct</span> <span class="ruby-comment">#=> -255</span>
<span class="ruby-string">"bad"</span>.<span class="ruby-identifier">oct</span> <span class="ruby-comment">#=> 0</span>
<span class="ruby-string">"0377bad"</span>.<span class="ruby-identifier">oct</span> <span class="ruby-comment">#=> 255</span>
</pre>
<p>If <code>str</code> starts with <code>0</code>, radix indicators are honored. See Kernel#Integer.</p>
<div class="method-source-code" id="oct-source">
<pre>static VALUE
rb_str_oct(VALUE str)
{
return rb_str_to_inum(str, -8, FALSE);
}</pre>
</div>
</div>
</div>
<div id="method-i-ord" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
ord → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the <a href="Integer.html"><code>Integer</code></a> ordinal of a one-character string.</p>
<pre class="ruby"><span class="ruby-string">"a"</span>.<span class="ruby-identifier">ord</span> <span class="ruby-comment">#=> 97</span>
</pre>
<div class="method-source-code" id="ord-source">
<pre>VALUE
rb_str_ord(VALUE s)
{
unsigned int c;
c = rb_enc_codepoint(RSTRING_PTR(s), RSTRING_END(s), STR_ENC_GET(s));
return UINT2NUM(c);
}</pre>
</div>
</div>
</div>
<div id="method-i-partition" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
partition(sep) → [head, sep, tail]
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
partition(regexp) → [head, match, tail]
</span>
</div>
<div class="method-description">
<p>Searches <em>sep</em> or pattern (<em>regexp</em>) in the string and returns the part before it, the match, and the part after it. If it is not found, returns two empty strings and <em>str</em>.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">partition</span>(<span class="ruby-string">"l"</span>) <span class="ruby-comment">#=> ["he", "l", "lo"]</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">partition</span>(<span class="ruby-string">"x"</span>) <span class="ruby-comment">#=> ["hello", "", ""]</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">partition</span>(<span class="ruby-regexp">/.l/</span>) <span class="ruby-comment">#=> ["h", "el", "lo"]</span>
</pre>
<div class="method-source-code" id="partition-source">
<pre>static VALUE
rb_str_partition(VALUE str, VALUE sep)
{
long pos;
sep = get_pat_quoted(sep, 0);
if (RB_TYPE_P(sep, T_REGEXP)) {
pos = rb_reg_search(sep, str, 0, 0);
if (pos < 0) {
failed:
return rb_ary_new3(3, rb_str_dup(str), str_new_empty(str), str_new_empty(str));
}
sep = rb_str_subpat(str, sep, INT2FIX(0));
if (pos == 0 && RSTRING_LEN(sep) == 0) goto failed;
}
else {
pos = rb_str_index(str, sep, 0);
if (pos < 0) goto failed;
}
return rb_ary_new3(3, rb_str_subseq(str, 0, pos),
sep,
rb_str_subseq(str, pos+RSTRING_LEN(sep),
RSTRING_LEN(str)-pos-RSTRING_LEN(sep)));
}</pre>
</div>
</div>
</div>
<div id="method-i-prepend" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
prepend(other_str1, other_str2, ...) → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Prepend—Prepend the given strings to <em>str</em>.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-string">"!"</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">prepend</span>(<span class="ruby-string">"hello "</span>, <span class="ruby-string">"world"</span>) <span class="ruby-comment">#=> "hello world!"</span>
<span class="ruby-identifier">a</span> <span class="ruby-comment">#=> "hello world!"</span>
</pre>
<p>See also <a href="String.html#method-i-concat"><code>String#concat</code></a>.</p>
<div class="method-source-code" id="prepend-source">
<pre>static VALUE
rb_str_prepend_multi(int argc, VALUE *argv, VALUE str)
{
str_modifiable(str);
if (argc == 1) {
rb_str_update(str, 0L, 0L, argv[0]);
}
else if (argc > 1) {
int i;
VALUE arg_str = rb_str_tmp_new(0);
rb_enc_copy(arg_str, str);
for (i = 0; i < argc; i++) {
rb_str_append(arg_str, argv[i]);
}
rb_str_update(str, 0L, 0L, arg_str);
}
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-replace" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
replace(other_str) → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Replaces the contents of <em>str</em> with the corresponding values in <em>other_str</em>.</p>
<pre class="ruby"><span class="ruby-identifier">s</span> = <span class="ruby-string">"hello"</span> <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">replace</span> <span class="ruby-string">"world"</span> <span class="ruby-comment">#=> "world"</span>
</pre>
<div class="method-source-code" id="replace-source">
<pre>VALUE
rb_str_replace(VALUE str, VALUE str2)
{
str_modifiable(str);
if (str == str2) return str;
StringValue(str2);
str_discard(str);
return str_replace(str, str2);
}</pre>
</div>
</div>
</div>
<div id="method-i-reverse" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
reverse → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a new string with the characters from <em>str</em> in reverse order.</p>
<pre class="ruby"><span class="ruby-string">"stressed"</span>.<span class="ruby-identifier">reverse</span> <span class="ruby-comment">#=> "desserts"</span>
</pre>
<div class="method-source-code" id="reverse-source">
<pre>static VALUE
rb_str_reverse(VALUE str)
{
rb_encoding *enc;
VALUE rev;
char *s, *e, *p;
int cr;
if (RSTRING_LEN(str) <= 1) return rb_str_dup(str);
enc = STR_ENC_GET(str);
rev = rb_str_new_with_class(str, 0, RSTRING_LEN(str));
s = RSTRING_PTR(str); e = RSTRING_END(str);
p = RSTRING_END(rev);
cr = ENC_CODERANGE(str);
if (RSTRING_LEN(str) > 1) {
if (single_byte_optimizable(str)) {
while (s < e) {
*--p = *s++;
}
}
else if (cr == ENC_CODERANGE_VALID) {
while (s < e) {
int clen = rb_enc_fast_mbclen(s, e, enc);
p -= clen;
memcpy(p, s, clen);
s += clen;
}
}
else {
cr = rb_enc_asciicompat(enc) ?
ENC_CODERANGE_7BIT : ENC_CODERANGE_VALID;
while (s < e) {
int clen = rb_enc_mbclen(s, e, enc);
if (clen > 1 || (*s & 0x80)) cr = ENC_CODERANGE_UNKNOWN;
p -= clen;
memcpy(p, s, clen);
s += clen;
}
}
}
STR_SET_LEN(rev, RSTRING_LEN(str));
str_enc_copy(rev, str);
ENC_CODERANGE_SET(rev, cr);
return rev;
}</pre>
</div>
</div>
</div>
<div id="method-i-reverse-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
reverse! → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reverses <em>str</em> in place.</p>
<div class="method-source-code" id="reverse-21-source">
<pre>static VALUE
rb_str_reverse_bang(VALUE str)
{
if (RSTRING_LEN(str) > 1) {
if (single_byte_optimizable(str)) {
char *s, *e, c;
str_modify_keep_cr(str);
s = RSTRING_PTR(str);
e = RSTRING_END(str) - 1;
while (s < e) {
c = *s;
*s++ = *e;
*e-- = c;
}
}
else {
str_shared_replace(str, rb_str_reverse(str));
}
}
else {
str_modify_keep_cr(str);
}
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-rindex" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
rindex(substring [, integer]) → integer or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
rindex(regexp [, integer]) → integer or nil
</span>
</div>
<div class="method-description">
<p>Returns the index of the last occurrence of the given <em>substring</em> or pattern (<em>regexp</em>) in <em>str</em>. Returns <code>nil</code> if not found. If the second parameter is present, it specifies the position in the string to end the search—characters beyond this point will not be considered.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rindex</span>(<span class="ruby-string">'e'</span>) <span class="ruby-comment">#=> 1</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rindex</span>(<span class="ruby-string">'l'</span>) <span class="ruby-comment">#=> 3</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rindex</span>(<span class="ruby-string">'a'</span>) <span class="ruby-comment">#=> nil</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rindex</span>(<span class="ruby-value">?e</span>) <span class="ruby-comment">#=> 1</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rindex</span>(<span class="ruby-regexp">/[aeiou]/</span>, <span class="ruby-value">-2</span>) <span class="ruby-comment">#=> 1</span>
</pre>
<div class="method-source-code" id="rindex-source">
<pre>static VALUE
rb_str_rindex_m(int argc, VALUE *argv, VALUE str)
{
VALUE sub;
VALUE vpos;
rb_encoding *enc = STR_ENC_GET(str);
long pos, len = str_strlen(str, enc); /* str's enc */
if (rb_scan_args(argc, argv, "11", &sub, &vpos) == 2) {
pos = NUM2LONG(vpos);
if (pos < 0) {
pos += len;
if (pos < 0) {
if (RB_TYPE_P(sub, T_REGEXP)) {
rb_backref_set(Qnil);
}
return Qnil;
}
}
if (pos > len) pos = len;
}
else {
pos = len;
}
if (SPECIAL_CONST_P(sub)) goto generic;
switch (BUILTIN_TYPE(sub)) {
case T_REGEXP:
/* enc = rb_get_check(str, sub); */
pos = str_offset(RSTRING_PTR(str), RSTRING_END(str), pos,
enc, single_byte_optimizable(str));
pos = rb_reg_search(sub, str, pos, 1);
pos = rb_str_sublen(str, pos);
if (pos >= 0) return LONG2NUM(pos);
break;
generic:
default: {
VALUE tmp;
tmp = rb_check_string_type(sub);
if (NIL_P(tmp)) {
rb_raise(rb_eTypeError, "type mismatch: %s given",
rb_obj_classname(sub));
}
sub = tmp;
}
/* fall through */
case T_STRING:
pos = rb_str_rindex(str, sub, pos);
if (pos >= 0) return LONG2NUM(pos);
break;
}
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-rjust" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
rjust(integer, padstr=' ') → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>If <em>integer</em> is greater than the length of <em>str</em>, returns a new <a href="String.html"><code>String</code></a> of length <em>integer</em> with <em>str</em> right justified and padded with <em>padstr</em>; otherwise, returns <em>str</em>.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rjust</span>(<span class="ruby-value">4</span>) <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rjust</span>(<span class="ruby-value">20</span>) <span class="ruby-comment">#=> " hello"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rjust</span>(<span class="ruby-value">20</span>, <span class="ruby-string">'1234'</span>) <span class="ruby-comment">#=> "123412341234123hello"</span>
</pre>
<div class="method-source-code" id="rjust-source">
<pre>static VALUE
rb_str_rjust(int argc, VALUE *argv, VALUE str)
{
return rb_str_justify(argc, argv, str, 'r');
}</pre>
</div>
</div>
</div>
<div id="method-i-rpartition" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
rpartition(sep) → [head, sep, tail]
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
rpartition(regexp) → [head, match, tail]
</span>
</div>
<div class="method-description">
<p>Searches <em>sep</em> or pattern (<em>regexp</em>) in the string from the end of the string, and returns the part before it, the match, and the part after it. If it is not found, returns two empty strings and <em>str</em>.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rpartition</span>(<span class="ruby-string">"l"</span>) <span class="ruby-comment">#=> ["hel", "l", "o"]</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rpartition</span>(<span class="ruby-string">"x"</span>) <span class="ruby-comment">#=> ["", "", "hello"]</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rpartition</span>(<span class="ruby-regexp">/.l/</span>) <span class="ruby-comment">#=> ["he", "ll", "o"]</span>
</pre>
<div class="method-source-code" id="rpartition-source">
<pre>static VALUE
rb_str_rpartition(VALUE str, VALUE sep)
{
long pos = RSTRING_LEN(str);
int regex = FALSE;
if (RB_TYPE_P(sep, T_REGEXP)) {
pos = rb_reg_search(sep, str, pos, 1);
regex = TRUE;
}
else {
VALUE tmp;
tmp = rb_check_string_type(sep);
if (NIL_P(tmp)) {
rb_raise(rb_eTypeError, "type mismatch: %s given",
rb_obj_classname(sep));
}
sep = tmp;
pos = rb_str_sublen(str, pos);
pos = rb_str_rindex(str, sep, pos);
}
if (pos < 0) {
return rb_ary_new3(3, str_new_empty(str), str_new_empty(str), rb_str_dup(str));
}
if (regex) {
sep = rb_reg_nth_match(0, rb_backref_get());
}
else {
pos = rb_str_offset(str, pos);
}
return rb_ary_new3(3, rb_str_subseq(str, 0, pos),
sep,
rb_str_subseq(str, pos+RSTRING_LEN(sep),
RSTRING_LEN(str)-pos-RSTRING_LEN(sep)));
}</pre>
</div>
</div>
</div>
<div id="method-i-rstrip" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
rstrip → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a copy of the receiver with trailing whitespace removed. See also <a href="String.html#method-i-lstrip"><code>String#lstrip</code></a> and <a href="String.html#method-i-strip"><code>String#strip</code></a>.</p>
<p>Refer to <a href="String.html#method-i-strip"><code>String#strip</code></a> for the definition of whitespace.</p>
<pre class="ruby"><span class="ruby-string">" hello "</span>.<span class="ruby-identifier">rstrip</span> <span class="ruby-comment">#=> " hello"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rstrip</span> <span class="ruby-comment">#=> "hello"</span>
</pre>
<div class="method-source-code" id="rstrip-source">
<pre>static VALUE
rb_str_rstrip(VALUE str)
{
rb_encoding *enc;
char *start;
long olen, roffset;
enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, start, olen);
roffset = rstrip_offset(str, start, start+olen, enc);
if (roffset <= 0) return rb_str_dup(str);
return rb_str_subseq(str, 0, olen-roffset);
}</pre>
</div>
</div>
</div>
<div id="method-i-rstrip-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
rstrip! → self or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes trailing whitespace from the receiver. Returns the altered receiver, or <code>nil</code> if no change was made. See also <a href="String.html#method-i-lstrip-21"><code>String#lstrip!</code></a> and <a href="String.html#method-i-strip-21"><code>String#strip!</code></a>.</p>
<p>Refer to <a href="String.html#method-i-strip"><code>String#strip</code></a> for the definition of whitespace.</p>
<pre class="ruby"><span class="ruby-string">" hello "</span>.<span class="ruby-identifier">rstrip!</span> <span class="ruby-comment">#=> " hello"</span>
<span class="ruby-string">" hello"</span>.<span class="ruby-identifier">rstrip!</span> <span class="ruby-comment">#=> nil</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">rstrip!</span> <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="rstrip-21-source">
<pre>static VALUE
rb_str_rstrip_bang(VALUE str)
{
rb_encoding *enc;
char *start;
long olen, roffset;
str_modify_keep_cr(str);
enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, start, olen);
roffset = rstrip_offset(str, start, start+olen, enc);
if (roffset > 0) {
long len = olen - roffset;
STR_SET_LEN(str, len);
#if !SHARABLE_MIDDLE_SUBSTRING
TERM_FILL(start+len, rb_enc_mbminlen(enc));
#endif
return str;
}
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-scan" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
scan(pattern) → array
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
scan(pattern) {|match, ...| block } → str
</span>
</div>
<div class="method-description">
<p>Both forms iterate through <em>str</em>, matching the pattern (which may be a <a href="Regexp.html"><code>Regexp</code></a> or a <a href="String.html"><code>String</code></a>). For each match, a result is generated and either added to the result array or passed to the block. If the pattern contains no groups, each individual result consists of the matched string, <code>$&</code>. If the pattern contains groups, each individual result is itself an array containing one entry per group.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-string">"cruel world"</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/\w+/</span>) <span class="ruby-comment">#=> ["cruel", "world"]</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/.../</span>) <span class="ruby-comment">#=> ["cru", "el ", "wor"]</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/(...)/</span>) <span class="ruby-comment">#=> [["cru"], ["el "], ["wor"]]</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/(..)(..)/</span>) <span class="ruby-comment">#=> [["cr", "ue"], ["l ", "wo"]]</span>
</pre>
<p>And the block form:</p>
<pre class="ruby"><span class="ruby-identifier">a</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/\w+/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">w</span><span class="ruby-operator">|</span> <span class="ruby-identifier">print</span> <span class="ruby-node">"<<#{w}>> "</span> }
<span class="ruby-identifier">print</span> <span class="ruby-string">"\n"</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/(.)(.)/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">x</span>,<span class="ruby-identifier">y</span><span class="ruby-operator">|</span> <span class="ruby-identifier">print</span> <span class="ruby-identifier">y</span>, <span class="ruby-identifier">x</span> }
<span class="ruby-identifier">print</span> <span class="ruby-string">"\n"</span>
</pre>
<p><em>produces:</em></p>
<pre><<cruel>> <<world>>
rceu lowlr</pre>
<div class="method-source-code" id="scan-source">
<pre>static VALUE
rb_str_scan(VALUE str, VALUE pat)
{
VALUE result;
long start = 0;
long last = -1, prev = 0;
char *p = RSTRING_PTR(str); long len = RSTRING_LEN(str);
pat = get_pat_quoted(pat, 1);
mustnot_broken(str);
if (!rb_block_given_p()) {
VALUE ary = rb_ary_new();
while (!NIL_P(result = scan_once(str, pat, &start, 0))) {
last = prev;
prev = start;
rb_ary_push(ary, result);
}
if (last >= 0) rb_pat_search(pat, str, last, 1);
else rb_backref_set(Qnil);
return ary;
}
while (!NIL_P(result = scan_once(str, pat, &start, 1))) {
last = prev;
prev = start;
rb_yield(result);
str_mod_check(str, p, len);
}
if (last >= 0) rb_pat_search(pat, str, last, 1);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-scrub" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
scrub → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
scrub(repl) → new_str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
scrub{|bytes|} → new_str
</span>
</div>
<div class="method-description">
<p>If the string is invalid byte sequence then replace invalid bytes with given replacement character, else returns self. If block is given, replace invalid bytes with returned value of the block.</p>
<pre class="ruby"><span class="ruby-string">"abc\u3042\x81"</span>.<span class="ruby-identifier">scrub</span> <span class="ruby-comment">#=> "abc\u3042\uFFFD"</span>
<span class="ruby-string">"abc\u3042\x81"</span>.<span class="ruby-identifier">scrub</span>(<span class="ruby-string">"*"</span>) <span class="ruby-comment">#=> "abc\u3042*"</span>
<span class="ruby-string">"abc\u3042\xE3\x80"</span>.<span class="ruby-identifier">scrub</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">bytes</span><span class="ruby-operator">|</span> <span class="ruby-string">'<'</span><span class="ruby-operator">+</span><span class="ruby-identifier">bytes</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'H*'</span>)[<span class="ruby-value">0</span>]<span class="ruby-string">+'>'</span> } <span class="ruby-comment">#=> "abc\u3042<e380>"</span>
</pre>
<div class="method-source-code" id="scrub-source">
<pre>static VALUE
str_scrub(int argc, VALUE *argv, VALUE str)
{
VALUE repl = argc ? (rb_check_arity(argc, 0, 1), argv[0]) : Qnil;
VALUE new = rb_str_scrub(str, repl);
return NIL_P(new) ? rb_str_dup(str): new;
}</pre>
</div>
</div>
</div>
<div id="method-i-scrub-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
scrub! → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
scrub!(repl) → str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
scrub!{|bytes|} → str
</span>
</div>
<div class="method-description">
<p>If the string is invalid byte sequence then replace invalid bytes with given replacement character, else returns self. If block is given, replace invalid bytes with returned value of the block.</p>
<pre class="ruby"><span class="ruby-string">"abc\u3042\x81"</span>.<span class="ruby-identifier">scrub!</span> <span class="ruby-comment">#=> "abc\u3042\uFFFD"</span>
<span class="ruby-string">"abc\u3042\x81"</span>.<span class="ruby-identifier">scrub!</span>(<span class="ruby-string">"*"</span>) <span class="ruby-comment">#=> "abc\u3042*"</span>
<span class="ruby-string">"abc\u3042\xE3\x80"</span>.<span class="ruby-identifier">scrub!</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">bytes</span><span class="ruby-operator">|</span> <span class="ruby-string">'<'</span><span class="ruby-operator">+</span><span class="ruby-identifier">bytes</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'H*'</span>)[<span class="ruby-value">0</span>]<span class="ruby-string">+'>'</span> } <span class="ruby-comment">#=> "abc\u3042<e380>"</span>
</pre>
<div class="method-source-code" id="scrub-21-source">
<pre>static VALUE
str_scrub_bang(int argc, VALUE *argv, VALUE str)
{
VALUE repl = argc ? (rb_check_arity(argc, 0, 1), argv[0]) : Qnil;
VALUE new = rb_str_scrub(str, repl);
if (!NIL_P(new)) rb_str_replace(str, new);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-setbyte" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
setbyte(index, integer) → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>modifies the <em>index</em>th byte as <em>integer</em>.</p>
<div class="method-source-code" id="setbyte-source">
<pre>static VALUE
rb_str_setbyte(VALUE str, VALUE index, VALUE value)
{
long pos = NUM2LONG(index);
long len = RSTRING_LEN(str);
char *head, *left = 0;
unsigned char *ptr;
rb_encoding *enc;
int cr = ENC_CODERANGE_UNKNOWN, width, nlen;
if (pos < -len || len <= pos)
rb_raise(rb_eIndexError, "index %ld out of string", pos);
if (pos < 0)
pos += len;
VALUE v = rb_to_int(value);
VALUE w = rb_int_and(v, INT2FIX(0xff));
unsigned char byte = NUM2INT(w) & 0xFF;
if (!str_independent(str))
str_make_independent(str);
enc = STR_ENC_GET(str);
head = RSTRING_PTR(str);
ptr = (unsigned char *)&head[pos];
if (!STR_EMBED_P(str)) {
cr = ENC_CODERANGE(str);
switch (cr) {
case ENC_CODERANGE_7BIT:
left = (char *)ptr;
*ptr = byte;
if (ISASCII(byte)) goto end;
nlen = rb_enc_precise_mbclen(left, head+len, enc);
if (!MBCLEN_CHARFOUND_P(nlen))
ENC_CODERANGE_SET(str, ENC_CODERANGE_BROKEN);
else
ENC_CODERANGE_SET(str, ENC_CODERANGE_VALID);
goto end;
case ENC_CODERANGE_VALID:
left = rb_enc_left_char_head(head, ptr, head+len, enc);
width = rb_enc_precise_mbclen(left, head+len, enc);
*ptr = byte;
nlen = rb_enc_precise_mbclen(left, head+len, enc);
if (!MBCLEN_CHARFOUND_P(nlen))
ENC_CODERANGE_SET(str, ENC_CODERANGE_BROKEN);
else if (MBCLEN_CHARFOUND_LEN(nlen) != width || ISASCII(byte))
ENC_CODERANGE_CLEAR(str);
goto end;
}
}
ENC_CODERANGE_CLEAR(str);
*ptr = byte;
end:
return value;
}</pre>
</div>
</div>
</div>
<div id="method-i-shellescape" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
shellescape → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Escapes <code>str</code> so that it can be safely used in a Bourne shell command line.</p>
<p>See <a href="Shellwords.html#method-c-shellescape"><code>Shellwords.shellescape</code></a> for details.</p>
<div class="method-source-code" id="shellescape-source">
<pre><span class="ruby-comment"># File lib/shellwords.rb, line 215</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">shellescape</span>
<span class="ruby-constant">Shellwords</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-shellsplit" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
shellsplit → array
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Splits <code>str</code> into an array of tokens in the same way the UNIX Bourne shell does.</p>
<p>See <a href="Shellwords.html#method-c-shellsplit"><code>Shellwords.shellsplit</code></a> for details.</p>
<div class="method-source-code" id="shellsplit-source">
<pre><span class="ruby-comment"># File lib/shellwords.rb, line 204</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">shellsplit</span>
<span class="ruby-constant">Shellwords</span>.<span class="ruby-identifier">split</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-size" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
size → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the character length of <em>str</em>.</p>
<div class="method-source-code" id="size-source">
<pre>VALUE
rb_str_length(VALUE str)
{
return LONG2NUM(str_strlen(str, NULL));
}</pre>
</div>
</div>
</div>
<div id="method-i-slice" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
slice(index) → new_str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
slice(start, length) → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
slice(range) → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
slice(regexp) → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
slice(regexp, capture) → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
slice(match_str) → new_str or nil
</span>
</div>
<div class="method-description">
<p>Element Reference — If passed a single <code>index</code>, returns a substring of one character at that index. If passed a <code>start</code> index and a <code>length</code>, returns a substring containing <code>length</code> characters starting at the <code>start</code> index. If passed a <code>range</code>, its beginning and end are interpreted as offsets delimiting the substring to be returned.</p>
<p>In these three cases, if an index is negative, it is counted from the end of the string. For the <code>start</code> and <code>range</code> cases the starting index is just before a character and an index matching the string's size. Additionally, an empty string is returned when the starting index for a character range is at the end of the string.</p>
<p>Returns <code>nil</code> if the initial index falls outside the string or the length is negative.</p>
<p>If a <code>Regexp</code> is supplied, the matching portion of the string is returned. If a <code>capture</code> follows the regular expression, which may be a capture group index or name, follows the regular expression that component of the <a href="MatchData.html"><code>MatchData</code></a> is returned instead.</p>
<p>If a <code>match_str</code> is given, that string is returned if it occurs in the string.</p>
<p>Returns <code>nil</code> if the regular expression does not match or the match string cannot be found.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-string">"hello there"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">1</span>] <span class="ruby-comment">#=> "e"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">2</span>, <span class="ruby-value">3</span>] <span class="ruby-comment">#=> "llo"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">2</span><span class="ruby-operator">..</span><span class="ruby-value">3</span>] <span class="ruby-comment">#=> "ll"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">-3</span>, <span class="ruby-value">2</span>] <span class="ruby-comment">#=> "er"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">7</span><span class="ruby-operator">..</span><span class="ruby-value">-2</span>] <span class="ruby-comment">#=> "her"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">-4</span><span class="ruby-operator">..</span><span class="ruby-value">-2</span>] <span class="ruby-comment">#=> "her"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">-2</span><span class="ruby-operator">..</span><span class="ruby-value">-4</span>] <span class="ruby-comment">#=> ""</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">11</span>, <span class="ruby-value">0</span>] <span class="ruby-comment">#=> ""</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">11</span>] <span class="ruby-comment">#=> nil</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">12</span>, <span class="ruby-value">0</span>] <span class="ruby-comment">#=> nil</span>
<span class="ruby-identifier">a</span>[<span class="ruby-value">12</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] <span class="ruby-comment">#=> nil</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/[aeiou](.)\1/</span>] <span class="ruby-comment">#=> "ell"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/[aeiou](.)\1/</span>, <span class="ruby-value">0</span>] <span class="ruby-comment">#=> "ell"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/[aeiou](.)\1/</span>, <span class="ruby-value">1</span>] <span class="ruby-comment">#=> "l"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/[aeiou](.)\1/</span>, <span class="ruby-value">2</span>] <span class="ruby-comment">#=> nil</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/(?<vowel>[aeiou])(?<non_vowel>[^aeiou])/</span>, <span class="ruby-string">"non_vowel"</span>] <span class="ruby-comment">#=> "l"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-regexp">/(?<vowel>[aeiou])(?<non_vowel>[^aeiou])/</span>, <span class="ruby-string">"vowel"</span>] <span class="ruby-comment">#=> "e"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-string">"lo"</span>] <span class="ruby-comment">#=> "lo"</span>
<span class="ruby-identifier">a</span>[<span class="ruby-string">"bye"</span>] <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="slice-source">
<pre>static VALUE
rb_str_aref_m(int argc, VALUE *argv, VALUE str)
{
if (argc == 2) {
if (RB_TYPE_P(argv[0], T_REGEXP)) {
return rb_str_subpat(str, argv[0], argv[1]);
}
else {
long beg = NUM2LONG(argv[0]);
long len = NUM2LONG(argv[1]);
return rb_str_substr(str, beg, len);
}
}
rb_check_arity(argc, 1, 2);
return rb_str_aref(str, argv[0]);
}</pre>
</div>
</div>
</div>
<div id="method-i-slice-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
slice!(integer) → new_str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
slice!(integer, integer) → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
slice!(range) → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
slice!(regexp) → new_str or nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
slice!(other_str) → new_str or nil
</span>
</div>
<div class="method-description">
<p>Deletes the specified portion from <em>str</em>, and returns the portion deleted.</p>
<pre class="ruby"><span class="ruby-identifier">string</span> = <span class="ruby-string">"this is a string"</span>
<span class="ruby-identifier">string</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">2</span>) <span class="ruby-comment">#=> "i"</span>
<span class="ruby-identifier">string</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">3</span><span class="ruby-operator">..</span><span class="ruby-value">6</span>) <span class="ruby-comment">#=> " is "</span>
<span class="ruby-identifier">string</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-regexp">/s.*t/</span>) <span class="ruby-comment">#=> "sa st"</span>
<span class="ruby-identifier">string</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-string">"r"</span>) <span class="ruby-comment">#=> "r"</span>
<span class="ruby-identifier">string</span> <span class="ruby-comment">#=> "thing"</span>
</pre>
<div class="method-source-code" id="slice-21-source">
<pre>static VALUE
rb_str_slice_bang(int argc, VALUE *argv, VALUE str)
{
VALUE result;
VALUE buf[3];
int i;
rb_check_arity(argc, 1, 2);
for (i=0; i<argc; i++) {
buf[i] = argv[i];
}
str_modify_keep_cr(str);
result = rb_str_aref_m(argc, buf, str);
if (!NIL_P(result)) {
buf[i] = rb_str_new(0,0);
rb_str_aset_m(argc+1, buf, str);
}
return result;
}</pre>
</div>
</div>
</div>
<div id="method-i-split" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
split(pattern=nil, [limit]) → an_array
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
split(pattern=nil, [limit]) {|sub| block } → str
</span>
</div>
<div class="method-description">
<p>Divides <em>str</em> into substrings based on a delimiter, returning an array of these substrings.</p>
<p>If <em>pattern</em> is a <a href="String.html"><code>String</code></a>, then its contents are used as the delimiter when splitting <em>str</em>. If <em>pattern</em> is a single space, <em>str</em> is split on whitespace, with leading and trailing whitespace and runs of contiguous whitespace characters ignored.</p>
<p>If <em>pattern</em> is a <a href="Regexp.html"><code>Regexp</code></a>, <em>str</em> is divided where the pattern matches. Whenever the pattern matches a zero-length string, <em>str</em> is split into individual characters. If <em>pattern</em> contains groups, the respective matches will be returned in the array as well.</p>
<p>If <em>pattern</em> is <code>nil</code>, the value of <code>$;</code> is used. If <code>$;</code> is <code>nil</code> (which is the default), <em>str</em> is split on whitespace as if ' ' were specified.</p>
<p>If the <em>limit</em> parameter is omitted, trailing null fields are suppressed. If <em>limit</em> is a positive number, at most that number of split substrings will be returned (captured groups will be returned as well, but are not counted towards the limit). If <em>limit</em> is <code>1</code>, the entire string is returned as the only entry in an array. If negative, there is no limit to the number of fields returned, and trailing null fields are not suppressed.</p>
<p>When the input <code>str</code> is empty an empty <a href="Array.html"><code>Array</code></a> is returned as the string is considered to have no fields to split.</p>
<pre class="ruby"><span class="ruby-string">" now's the time "</span>.<span class="ruby-identifier">split</span> <span class="ruby-comment">#=> ["now's", "the", "time"]</span>
<span class="ruby-string">" now's the time "</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">' '</span>) <span class="ruby-comment">#=> ["now's", "the", "time"]</span>
<span class="ruby-string">" now's the time"</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/ /</span>) <span class="ruby-comment">#=> ["", "now's", "", "the", "time"]</span>
<span class="ruby-string">"1, 2.34,56, 7"</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">%r{,\s*}</span>) <span class="ruby-comment">#=> ["1", "2.34", "56", "7"]</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">//</span>) <span class="ruby-comment">#=> ["h", "e", "l", "l", "o"]</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">//</span>, <span class="ruby-value">3</span>) <span class="ruby-comment">#=> ["h", "e", "llo"]</span>
<span class="ruby-string">"hi mom"</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">%r{\s*}</span>) <span class="ruby-comment">#=> ["h", "i", "m", "o", "m"]</span>
<span class="ruby-string">"mellow yellow"</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"ello"</span>) <span class="ruby-comment">#=> ["m", "w y", "w"]</span>
<span class="ruby-string">"1,2,,3,4,,"</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">','</span>) <span class="ruby-comment">#=> ["1", "2", "", "3", "4"]</span>
<span class="ruby-string">"1,2,,3,4,,"</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">','</span>, <span class="ruby-value">4</span>) <span class="ruby-comment">#=> ["1", "2", "", "3,4,,"]</span>
<span class="ruby-string">"1,2,,3,4,,"</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">','</span>, <span class="ruby-value">-4</span>) <span class="ruby-comment">#=> ["1", "2", "", "3", "4", "", ""]</span>
<span class="ruby-string">"1:2:3"</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/(:)()()/</span>, <span class="ruby-value">2</span>) <span class="ruby-comment">#=> ["1", ":", "", "", "2:3"]</span>
<span class="ruby-string">""</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">','</span>, <span class="ruby-value">-1</span>) <span class="ruby-comment">#=> []</span>
</pre>
<p>If a block is given, invoke the block with each split substring.</p>
<div class="method-source-code" id="split-source">
<pre>static VALUE
rb_str_split_m(int argc, VALUE *argv, VALUE str)
{
rb_encoding *enc;
VALUE spat;
VALUE limit;
enum {awk, string, regexp, chars} split_type;
long beg, end, i = 0, empty_count = -1;
int lim = 0;
VALUE result, tmp;
result = rb_block_given_p() ? Qfalse : Qnil;
if (rb_scan_args(argc, argv, "02", &spat, &limit) == 2) {
lim = NUM2INT(limit);
if (lim <= 0) limit = Qnil;
else if (lim == 1) {
if (RSTRING_LEN(str) == 0)
return result ? rb_ary_new2(0) : str;
tmp = rb_str_dup(str);
if (!result) {
rb_yield(tmp);
return str;
}
return rb_ary_new3(1, tmp);
}
i = 1;
}
if (NIL_P(limit) && !lim) empty_count = 0;
enc = STR_ENC_GET(str);
split_type = regexp;
if (!NIL_P(spat)) {
spat = get_pat_quoted(spat, 0);
}
else if (NIL_P(spat = rb_fs)) {
split_type = awk;
}
else if (!(spat = rb_fs_check(spat))) {
rb_raise(rb_eTypeError, "value of $; must be String or Regexp");
}
else {
rb_warn("$; is set to non-nil value");
}
if (split_type != awk) {
if (BUILTIN_TYPE(spat) == T_STRING) {
rb_encoding *enc2 = STR_ENC_GET(spat);
mustnot_broken(spat);
split_type = string;
if (RSTRING_LEN(spat) == 0) {
/* Special case - split into chars */
split_type = chars;
}
else if (rb_enc_asciicompat(enc2) == 1) {
if (RSTRING_LEN(spat) == 1 && RSTRING_PTR(spat)[0] == ' ') {
split_type = awk;
}
}
else {
int l;
if (rb_enc_ascget(RSTRING_PTR(spat), RSTRING_END(spat), &l, enc2) == ' ' &&
RSTRING_LEN(spat) == l) {
split_type = awk;
}
}
}
}
#define SPLIT_STR(beg, len) (empty_count = split_string(result, str, beg, len, empty_count))
if (result) result = rb_ary_new();
beg = 0;
char *ptr = RSTRING_PTR(str);
char *eptr = RSTRING_END(str);
if (split_type == awk) {
char *bptr = ptr;
int skip = 1;
unsigned int c;
end = beg;
if (is_ascii_string(str)) {
while (ptr < eptr) {
c = (unsigned char)*ptr++;
if (skip) {
if (ascii_isspace(c)) {
beg = ptr - bptr;
}
else {
end = ptr - bptr;
skip = 0;
if (!NIL_P(limit) && lim <= i) break;
}
}
else if (ascii_isspace(c)) {
SPLIT_STR(beg, end-beg);
skip = 1;
beg = ptr - bptr;
if (!NIL_P(limit)) ++i;
}
else {
end = ptr - bptr;
}
}
}
else {
while (ptr < eptr) {
int n;
c = rb_enc_codepoint_len(ptr, eptr, &n, enc);
ptr += n;
if (skip) {
if (rb_isspace(c)) {
beg = ptr - bptr;
}
else {
end = ptr - bptr;
skip = 0;
if (!NIL_P(limit) && lim <= i) break;
}
}
else if (rb_isspace(c)) {
SPLIT_STR(beg, end-beg);
skip = 1;
beg = ptr - bptr;
if (!NIL_P(limit)) ++i;
}
else {
end = ptr - bptr;
}
}
}
}
else if (split_type == string) {
char *str_start = ptr;
char *substr_start = ptr;
char *sptr = RSTRING_PTR(spat);
long slen = RSTRING_LEN(spat);
mustnot_broken(str);
enc = rb_enc_check(str, spat);
while (ptr < eptr &&
(end = rb_memsearch(sptr, slen, ptr, eptr - ptr, enc)) >= 0) {
/* Check we are at the start of a char */
char *t = rb_enc_right_char_head(ptr, ptr + end, eptr, enc);
if (t != ptr + end) {
ptr = t;
continue;
}
SPLIT_STR(substr_start - str_start, (ptr+end) - substr_start);
ptr += end + slen;
substr_start = ptr;
if (!NIL_P(limit) && lim <= ++i) break;
}
beg = ptr - str_start;
}
else if (split_type == chars) {
char *str_start = ptr;
int n;
mustnot_broken(str);
enc = rb_enc_get(str);
while (ptr < eptr &&
(n = rb_enc_precise_mbclen(ptr, eptr, enc)) > 0) {
SPLIT_STR(ptr - str_start, n);
ptr += n;
if (!NIL_P(limit) && lim <= ++i) break;
}
beg = ptr - str_start;
}
else {
long len = RSTRING_LEN(str);
long start = beg;
long idx;
int last_null = 0;
struct re_registers *regs;
VALUE match = 0;
for (; (end = rb_reg_search(spat, str, start, 0)) >= 0;
(match ? (rb_match_unbusy(match), rb_backref_set(match)) : (void)0)) {
match = rb_backref_get();
if (!result) rb_match_busy(match);
regs = RMATCH_REGS(match);
if (start == end && BEG(0) == END(0)) {
if (!ptr) {
SPLIT_STR(0, 0);
break;
}
else if (last_null == 1) {
SPLIT_STR(beg, rb_enc_fast_mbclen(ptr+beg, eptr, enc));
beg = start;
}
else {
if (start == len)
start++;
else
start += rb_enc_fast_mbclen(ptr+start,eptr,enc);
last_null = 1;
continue;
}
}
else {
SPLIT_STR(beg, end-beg);
beg = start = END(0);
}
last_null = 0;
for (idx=1; idx < regs->num_regs; idx++) {
if (BEG(idx) == -1) continue;
SPLIT_STR(BEG(idx), END(idx)-BEG(idx));
}
if (!NIL_P(limit) && lim <= ++i) break;
}
if (match) rb_match_unbusy(match);
}
if (RSTRING_LEN(str) > 0 && (!NIL_P(limit) || RSTRING_LEN(str) > beg || lim < 0)) {
SPLIT_STR(beg, RSTRING_LEN(str)-beg);
}
return result ? result : str;
}</pre>
</div>
</div>
</div>
<div id="method-i-squeeze" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
squeeze([other_str]*) → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Builds a set of characters from the <em>other_str</em> parameter(s) using the procedure described for <a href="String.html#method-i-count"><code>String#count</code></a>. Returns a new string where runs of the same character that occur in this set are replaced by a single character. If no arguments are given, all runs of identical characters are replaced by a single character.</p>
<pre class="ruby"><span class="ruby-string">"yellow moon"</span>.<span class="ruby-identifier">squeeze</span> <span class="ruby-comment">#=> "yelow mon"</span>
<span class="ruby-string">" now is the"</span>.<span class="ruby-identifier">squeeze</span>(<span class="ruby-string">" "</span>) <span class="ruby-comment">#=> " now is the"</span>
<span class="ruby-string">"putters shoot balls"</span>.<span class="ruby-identifier">squeeze</span>(<span class="ruby-string">"m-z"</span>) <span class="ruby-comment">#=> "puters shot balls"</span>
</pre>
<div class="method-source-code" id="squeeze-source">
<pre>static VALUE
rb_str_squeeze(int argc, VALUE *argv, VALUE str)
{
str = rb_str_dup(str);
rb_str_squeeze_bang(argc, argv, str);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-squeeze-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
squeeze!([other_str]*) → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Squeezes <em>str</em> in place, returning either <em>str</em>, or <code>nil</code> if no changes were made.</p>
<div class="method-source-code" id="squeeze-21-source">
<pre>static VALUE
rb_str_squeeze_bang(int argc, VALUE *argv, VALUE str)
{
char squeez[TR_TABLE_SIZE];
rb_encoding *enc = 0;
VALUE del = 0, nodel = 0;
unsigned char *s, *send, *t;
int i, modify = 0;
int ascompat, singlebyte = single_byte_optimizable(str);
unsigned int save;
if (argc == 0) {
enc = STR_ENC_GET(str);
}
else {
for (i=0; i<argc; i++) {
VALUE s = argv[i];
StringValue(s);
enc = rb_enc_check(str, s);
if (singlebyte && !single_byte_optimizable(s))
singlebyte = 0;
tr_setup_table(s, squeez, i==0, &del, &nodel, enc);
}
}
str_modify_keep_cr(str);
s = t = (unsigned char *)RSTRING_PTR(str);
if (!s || RSTRING_LEN(str) == 0) return Qnil;
send = (unsigned char *)RSTRING_END(str);
save = -1;
ascompat = rb_enc_asciicompat(enc);
if (singlebyte) {
while (s < send) {
unsigned int c = *s++;
if (c != save || (argc > 0 && !squeez[c])) {
*t++ = save = c;
}
}
}
else {
while (s < send) {
unsigned int c;
int clen;
if (ascompat && (c = *s) < 0x80) {
if (c != save || (argc > 0 && !squeez[c])) {
*t++ = save = c;
}
s++;
}
else {
c = rb_enc_codepoint_len((char *)s, (char *)send, &clen, enc);
if (c != save || (argc > 0 && !tr_find(c, squeez, del, nodel))) {
if (t != s) rb_enc_mbcput(c, t, enc);
save = c;
t += clen;
}
s += clen;
}
}
}
TERM_FILL((char *)t, TERM_LEN(str));
if ((char *)t - RSTRING_PTR(str) != RSTRING_LEN(str)) {
STR_SET_LEN(str, (char *)t - RSTRING_PTR(str));
modify = 1;
}
if (modify) return str;
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-start_with-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
start_with?([prefixes]+) → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if <code>str</code> starts with one of the <code>prefixes</code> given. Each of the <code>prefixes</code> should be a <a href="String.html"><code>String</code></a> or a <a href="Regexp.html"><code>Regexp</code></a>.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">"hell"</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-regexp">/H/i</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-comment"># returns true if one of the prefixes matches.</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">"heaven"</span>, <span class="ruby-string">"hell"</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">"heaven"</span>, <span class="ruby-string">"paradise"</span>) <span class="ruby-comment">#=> false</span>
</pre>
<div class="method-source-code" id="start_with-3F-source">
<pre>static VALUE
rb_str_start_with(int argc, VALUE *argv, VALUE str)
{
int i;
for (i=0; i<argc; i++) {
VALUE tmp = argv[i];
if (RB_TYPE_P(tmp, T_REGEXP)) {
if (rb_reg_start_with_p(tmp, str))
return Qtrue;
}
else {
StringValue(tmp);
rb_enc_check(str, tmp);
if (RSTRING_LEN(str) < RSTRING_LEN(tmp)) continue;
if (memcmp(RSTRING_PTR(str), RSTRING_PTR(tmp), RSTRING_LEN(tmp)) == 0)
return Qtrue;
}
}
return Qfalse;
}</pre>
</div>
</div>
</div>
<div id="method-i-strip" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
strip → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a copy of the receiver with leading and trailing whitespace removed.</p>
<p>Whitespace is defined as any of the following characters: null, horizontal tab, line feed, vertical tab, form feed, carriage return, space.</p>
<pre class="ruby"><span class="ruby-string">" hello "</span>.<span class="ruby-identifier">strip</span> <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-string">"\tgoodbye\r\n"</span>.<span class="ruby-identifier">strip</span> <span class="ruby-comment">#=> "goodbye"</span>
<span class="ruby-string">"\x00\t\n\v\f\r "</span>.<span class="ruby-identifier">strip</span> <span class="ruby-comment">#=> ""</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">strip</span> <span class="ruby-comment">#=> "hello"</span>
</pre>
<div class="method-source-code" id="strip-source">
<pre>static VALUE
rb_str_strip(VALUE str)
{
char *start;
long olen, loffset, roffset;
rb_encoding *enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, start, olen);
loffset = lstrip_offset(str, start, start+olen, enc);
roffset = rstrip_offset(str, start+loffset, start+olen, enc);
if (loffset <= 0 && roffset <= 0) return rb_str_dup(str);
return rb_str_subseq(str, loffset, olen-loffset-roffset);
}</pre>
</div>
</div>
</div>
<div id="method-i-strip-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
strip! → self or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes leading and trailing whitespace from the receiver. Returns the altered receiver, or <code>nil</code> if there was no change.</p>
<p>Refer to <a href="String.html#method-i-strip"><code>String#strip</code></a> for the definition of whitespace.</p>
<pre class="ruby"><span class="ruby-string">" hello "</span>.<span class="ruby-identifier">strip!</span> <span class="ruby-comment">#=> "hello"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">strip!</span> <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="strip-21-source">
<pre>static VALUE
rb_str_strip_bang(VALUE str)
{
char *start;
long olen, loffset, roffset;
rb_encoding *enc;
str_modify_keep_cr(str);
enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, start, olen);
loffset = lstrip_offset(str, start, start+olen, enc);
roffset = rstrip_offset(str, start+loffset, start+olen, enc);
if (loffset > 0 || roffset > 0) {
long len = olen-roffset;
if (loffset > 0) {
len -= loffset;
memmove(start, start + loffset, len);
}
STR_SET_LEN(str, len);
#if !SHARABLE_MIDDLE_SUBSTRING
TERM_FILL(start+len, rb_enc_mbminlen(enc));
#endif
return str;
}
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-sub" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
sub(pattern, replacement) → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
sub(pattern, hash) → new_str
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
sub(pattern) {|match| block } → new_str
</span>
</div>
<div class="method-description">
<p>Returns a copy of <code>str</code> with the <em>first</em> occurrence of <code>pattern</code> replaced by the second argument. The <code>pattern</code> is typically a <a href="Regexp.html"><code>Regexp</code></a>; if given as a <a href="String.html"><code>String</code></a>, any regular expression metacharacters it contains will be interpreted literally, e.g. <code>\d</code> will match a backslash followed by 'd', instead of a digit.</p>
<p>If <code>replacement</code> is a <a href="String.html"><code>String</code></a> it will be substituted for the matched text. It may contain back-references to the pattern's capture groups of the form <code>\d</code>, where <em>d</em> is a group number, or <code>\k<n></code>, where <em>n</em> is a group name. Similarly, <code>\&</code>, <code>\'</code>, <code>\`</code>, and <code>+</code> correspond to special variables, <code>$&</code>, <code>$'</code>, <code>$`</code>, and <code>$+</code>, respectively. (See <a href="regexp_rdoc.html">regexp.rdoc</a> for details.) <code>\0</code> is the same as <code>\&</code>. <code>\\</code> is interpreted as an escape, i.e., a single backslash. Note that, within <code>replacement</code> the special match variables, such as <code>$&</code>, will not refer to the current match.</p>
<p>If the second argument is a <a href="Hash.html"><code>Hash</code></a>, and the matched text is one of its keys, the corresponding value is the replacement string.</p>
<p>In the block form, the current match string is passed in as a parameter, and variables such as <code>$1</code>, <code>$2</code>, <code>$`</code>, <code>$&</code>, and <code>$'</code> will be set appropriately. (See <a href="regexp_rdoc.html">regexp.rdoc</a> for details.) The value returned by the block will be substituted for the match on each call.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/[aeiou]/</span>, <span class="ruby-string">'*'</span>) <span class="ruby-comment">#=> "h*llo"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/([aeiou])/</span>, <span class="ruby-string">'<\1>'</span>) <span class="ruby-comment">#=> "h<e>llo"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/./</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">ord</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">' '</span> } <span class="ruby-comment">#=> "104 ello"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/(?<foo>[aeiou])/</span>, <span class="ruby-string">'*\k<foo>*'</span>) <span class="ruby-comment">#=> "h*e*llo"</span>
<span class="ruby-string">'Is SHELL your preferred shell?'</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/[[:upper:]]{2,}/</span>, <span class="ruby-constant">ENV</span>)
<span class="ruby-comment">#=> "Is /bin/bash your preferred shell?"</span>
</pre>
<p>Note that a string literal consumes backslashes. (See <a href="syntax/literals_rdoc.html">syntax/literals.rdoc</a> for details about string literals.) Back-references are typically preceded by an additional backslash. For example, if you want to write a back-reference <code>\&</code> in <code>replacement</code> with a double-quoted string literal, you need to write: <code>"..\\&.."</code>. If you want to write a non-back-reference string <code>\&</code> in <code>replacement</code>, you need first to escape the backslash to prevent this method from interpreting it as a back-reference, and then you need to escape the backslashes again to prevent a string literal from consuming them: <code>"..\\\\&.."</code>. You may want to use the block form to avoid a lot of backslashes.</p>
<div class="method-source-code" id="sub-source">
<pre>static VALUE
rb_str_sub(int argc, VALUE *argv, VALUE str)
{
str = rb_str_dup(str);
rb_str_sub_bang(argc, argv, str);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-sub-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
sub!(pattern, replacement) → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
sub!(pattern) {|match| block } → str or nil
</span>
</div>
<div class="method-description">
<p>Performs the same substitution as <a href="String.html#method-i-sub"><code>String#sub</code></a> in-place.</p>
<p>Returns <code>str</code> if a substitution was performed or <code>nil</code> if no substitution was performed.</p>
<div class="method-source-code" id="sub-21-source">
<pre>static VALUE
rb_str_sub_bang(int argc, VALUE *argv, VALUE str)
{
VALUE pat, repl, hash = Qnil;
int iter = 0;
long plen;
int min_arity = rb_block_given_p() ? 1 : 2;
long beg;
rb_check_arity(argc, min_arity, 2);
if (argc == 1) {
iter = 1;
}
else {
repl = argv[1];
hash = rb_check_hash_type(argv[1]);
if (NIL_P(hash)) {
StringValue(repl);
}
}
pat = get_pat_quoted(argv[0], 1);
str_modifiable(str);
beg = rb_pat_search(pat, str, 0, 1);
if (beg >= 0) {
rb_encoding *enc;
int cr = ENC_CODERANGE(str);
long beg0, end0;
VALUE match, match0 = Qnil;
struct re_registers *regs;
char *p, *rp;
long len, rlen;
match = rb_backref_get();
regs = RMATCH_REGS(match);
if (RB_TYPE_P(pat, T_STRING)) {
beg0 = beg;
end0 = beg0 + RSTRING_LEN(pat);
match0 = pat;
}
else {
beg0 = BEG(0);
end0 = END(0);
if (iter) match0 = rb_reg_nth_match(0, match);
}
if (iter || !NIL_P(hash)) {
p = RSTRING_PTR(str); len = RSTRING_LEN(str);
if (iter) {
repl = rb_obj_as_string(rb_yield(match0));
}
else {
repl = rb_hash_aref(hash, rb_str_subseq(str, beg0, end0 - beg0));
repl = rb_obj_as_string(repl);
}
str_mod_check(str, p, len);
rb_check_frozen(str);
}
else {
repl = rb_reg_regsub(repl, str, regs, RB_TYPE_P(pat, T_STRING) ? Qnil : pat);
}
enc = rb_enc_compatible(str, repl);
if (!enc) {
rb_encoding *str_enc = STR_ENC_GET(str);
p = RSTRING_PTR(str); len = RSTRING_LEN(str);
if (coderange_scan(p, beg0, str_enc) != ENC_CODERANGE_7BIT ||
coderange_scan(p+end0, len-end0, str_enc) != ENC_CODERANGE_7BIT) {
rb_raise(rb_eEncCompatError, "incompatible character encodings: %s and %s",
rb_enc_name(str_enc),
rb_enc_name(STR_ENC_GET(repl)));
}
enc = STR_ENC_GET(repl);
}
rb_str_modify(str);
rb_enc_associate(str, enc);
if (ENC_CODERANGE_UNKNOWN < cr && cr < ENC_CODERANGE_BROKEN) {
int cr2 = ENC_CODERANGE(repl);
if (cr2 == ENC_CODERANGE_BROKEN ||
(cr == ENC_CODERANGE_VALID && cr2 == ENC_CODERANGE_7BIT))
cr = ENC_CODERANGE_UNKNOWN;
else
cr = cr2;
}
plen = end0 - beg0;
rlen = RSTRING_LEN(repl);
len = RSTRING_LEN(str);
if (rlen > plen) {
RESIZE_CAPA(str, len + rlen - plen);
}
p = RSTRING_PTR(str);
if (rlen != plen) {
memmove(p + beg0 + rlen, p + beg0 + plen, len - beg0 - plen);
}
rp = RSTRING_PTR(repl);
memmove(p + beg0, rp, rlen);
len += rlen - plen;
STR_SET_LEN(str, len);
TERM_FILL(&RSTRING_PTR(str)[len], TERM_LEN(str));
ENC_CODERANGE_SET(str, cr);
return str;
}
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-succ" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
succ → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the successor to <em>str</em>. The successor is calculated by incrementing characters starting from the rightmost alphanumeric (or the rightmost character if there are no alphanumerics) in the string. Incrementing a digit always results in another digit, and incrementing a letter results in another letter of the same case. Incrementing nonalphanumerics uses the underlying character set's collating sequence.</p>
<p>If the increment generates a “carry,'' the character to the left of it is incremented. This process repeats until there is no carry, adding an additional character if necessary.</p>
<pre class="ruby"><span class="ruby-string">"abcd"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "abce"</span>
<span class="ruby-string">"THX1138"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "THX1139"</span>
<span class="ruby-string">"<<koala>>"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "<<koalb>>"</span>
<span class="ruby-string">"1999zzz"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "2000aaa"</span>
<span class="ruby-string">"ZZZ9999"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "AAAA0000"</span>
<span class="ruby-string">"***"</span>.<span class="ruby-identifier">succ</span> <span class="ruby-comment">#=> "**+"</span>
</pre>
<div class="method-source-code" id="succ-source">
<pre>VALUE
rb_str_succ(VALUE orig)
{
VALUE str;
str = rb_str_new_with_class(orig, RSTRING_PTR(orig), RSTRING_LEN(orig));
rb_enc_cr_str_copy_for_substr(str, orig);
return str_succ(str);
}</pre>
</div>
</div>
</div>
<div id="method-i-succ-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
succ! → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Equivalent to <a href="String.html#method-i-succ"><code>String#succ</code></a>, but modifies the receiver in place.</p>
<div class="method-source-code" id="succ-21-source">
<pre>static VALUE
rb_str_succ_bang(VALUE str)
{
rb_str_modify(str);
str_succ(str);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-sum" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
sum(n=16) → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a basic <em>n</em>-bit checksum of the characters in <em>str</em>, where <em>n</em> is the optional <a href="Integer.html"><code>Integer</code></a> parameter, defaulting to 16. The result is simply the sum of the binary value of each byte in <em>str</em> modulo <code>2**n - 1</code>. This is not a particularly good checksum.</p>
<div class="method-source-code" id="sum-source">
<pre>static VALUE
rb_str_sum(int argc, VALUE *argv, VALUE str)
{
int bits = 16;
char *ptr, *p, *pend;
long len;
VALUE sum = INT2FIX(0);
unsigned long sum0 = 0;
if (rb_check_arity(argc, 0, 1) && (bits = NUM2INT(argv[0])) < 0) {
bits = 0;
}
ptr = p = RSTRING_PTR(str);
len = RSTRING_LEN(str);
pend = p + len;
while (p < pend) {
if (FIXNUM_MAX - UCHAR_MAX < sum0) {
sum = rb_funcall(sum, '+', 1, LONG2FIX(sum0));
str_mod_check(str, ptr, len);
sum0 = 0;
}
sum0 += (unsigned char)*p;
p++;
}
if (bits == 0) {
if (sum0) {
sum = rb_funcall(sum, '+', 1, LONG2FIX(sum0));
}
}
else {
if (sum == INT2FIX(0)) {
if (bits < (int)sizeof(long)*CHAR_BIT) {
sum0 &= (((unsigned long)1)<<bits)-1;
}
sum = LONG2FIX(sum0);
}
else {
VALUE mod;
if (sum0) {
sum = rb_funcall(sum, '+', 1, LONG2FIX(sum0));
}
mod = rb_funcall(INT2FIX(1), idLTLT, 1, INT2FIX(bits));
mod = rb_funcall(mod, '-', 1, INT2FIX(1));
sum = rb_funcall(sum, '&', 1, mod);
}
}
return sum;
}</pre>
</div>
</div>
</div>
<div id="method-i-swapcase" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
swapcase → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
swapcase([options]) → new_str
</span>
</div>
<div class="method-description">
<p>Returns a copy of <em>str</em> with uppercase alphabetic characters converted to lowercase and lowercase characters converted to uppercase.</p>
<p>See <a href="String.html#method-i-downcase"><code>String#downcase</code></a> for meaning of <code>options</code> and use with different encodings.</p>
<pre class="ruby"><span class="ruby-string">"Hello"</span>.<span class="ruby-identifier">swapcase</span> <span class="ruby-comment">#=> "hELLO"</span>
<span class="ruby-string">"cYbEr_PuNk11"</span>.<span class="ruby-identifier">swapcase</span> <span class="ruby-comment">#=> "CyBeR_pUnK11"</span>
</pre>
<div class="method-source-code" id="swapcase-source">
<pre>static VALUE
rb_str_swapcase(int argc, VALUE *argv, VALUE str)
{
rb_encoding *enc;
OnigCaseFoldType flags = ONIGENC_CASE_UPCASE | ONIGENC_CASE_DOWNCASE;
VALUE ret;
flags = check_case_options(argc, argv, flags);
enc = str_true_enc(str);
if (RSTRING_LEN(str) == 0 || !RSTRING_PTR(str)) return str;
if (flags&ONIGENC_CASE_ASCII_ONLY) {
ret = rb_str_new_with_class(str, 0, RSTRING_LEN(str));
rb_str_ascii_casemap(str, ret, &flags, enc);
}
else {
ret = rb_str_casemap(str, &flags, enc);
}
return ret;
}</pre>
</div>
</div>
</div>
<div id="method-i-swapcase-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
swapcase! → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
swapcase!([options]) → str or nil
</span>
</div>
<div class="method-description">
<p>Equivalent to <a href="String.html#method-i-swapcase"><code>String#swapcase</code></a>, but modifies the receiver in place, returning <em>str</em>, or <code>nil</code> if no changes were made.</p>
<p>See <a href="String.html#method-i-downcase"><code>String#downcase</code></a> for meaning of <code>options</code> and use with different encodings.</p>
<div class="method-source-code" id="swapcase-21-source">
<pre>static VALUE
rb_str_swapcase_bang(int argc, VALUE *argv, VALUE str)
{
rb_encoding *enc;
OnigCaseFoldType flags = ONIGENC_CASE_UPCASE | ONIGENC_CASE_DOWNCASE;
flags = check_case_options(argc, argv, flags);
str_modify_keep_cr(str);
enc = str_true_enc(str);
if (flags&ONIGENC_CASE_ASCII_ONLY)
rb_str_ascii_casemap(str, str, &flags, enc);
else
str_shared_replace(str, rb_str_casemap(str, &flags, enc));
if (ONIGENC_CASE_MODIFIED&flags) return str;
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-to_c" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
to_c → complex
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a complex which denotes the string form. The parser ignores leading whitespaces and trailing garbage. Any digit sequences can be separated by an underscore. Returns zero for null or garbage string.</p>
<pre class="ruby"><span class="ruby-string">'9'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> (9+0i)</span>
<span class="ruby-string">'2.5'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> (2.5+0i)</span>
<span class="ruby-string">'2.5/1'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> ((5/2)+0i)</span>
<span class="ruby-string">'-3/2'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> ((-3/2)+0i)</span>
<span class="ruby-string">'-i'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> (0-1i)</span>
<span class="ruby-string">'45i'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> (0+45i)</span>
<span class="ruby-string">'3-4i'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> (3-4i)</span>
<span class="ruby-string">'-4e2-4e-2i'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> (-400.0-0.04i)</span>
<span class="ruby-string">'-0.0-0.0i'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> (-0.0-0.0i)</span>
<span class="ruby-string">'1/2+3/4i'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> ((1/2)+(3/4)*i)</span>
<span class="ruby-string">'ruby'</span>.<span class="ruby-identifier">to_c</span> <span class="ruby-comment">#=> (0+0i)</span>
</pre>
<p>See <a href="Kernel.html"><code>Kernel</code></a>.Complex.</p>
<div class="method-source-code" id="to_c-source">
<pre>static VALUE
string_to_c(VALUE self)
{
char *s;
VALUE num;
rb_must_asciicompat(self);
s = RSTRING_PTR(self);
if (s && s[RSTRING_LEN(self)]) {
rb_str_modify(self);
s = RSTRING_PTR(self);
s[RSTRING_LEN(self)] = '\0';
}
if (!s)
s = (char *)"";
(void)parse_comp(s, 0, &num);
return num;
}</pre>
</div>
</div>
</div>
<div id="method-i-to_d" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
to_d → bigdecimal
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the result of interpreting leading characters in <code>str</code> as a <a href="BigDecimal.html"><code>BigDecimal</code></a>.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'bigdecimal'</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'bigdecimal/util'</span>
<span class="ruby-string">"0.5"</span>.<span class="ruby-identifier">to_d</span> <span class="ruby-comment"># => 0.5e0</span>
<span class="ruby-string">"123.45e1"</span>.<span class="ruby-identifier">to_d</span> <span class="ruby-comment"># => 0.12345e4</span>
<span class="ruby-string">"45.67 degrees"</span>.<span class="ruby-identifier">to_d</span> <span class="ruby-comment"># => 0.4567e2</span>
</pre>
<p>See also <a href="BasicObject.html#method-c-new"><code>BigDecimal::new</code></a>.</p>
<div class="method-source-code" id="to_d-source">
<pre><span class="ruby-comment"># File ext/bigdecimal/lib/bigdecimal/util.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_d</span>
<span class="ruby-constant">BigDecimal</span>.<span class="ruby-identifier">interpret_loosely</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_f" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
to_f → float
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the result of interpreting leading characters in <em>str</em> as a floating point number. Extraneous characters past the end of a valid number are ignored. If there is not a valid number at the start of <em>str</em>, <code>0.0</code> is returned. This method never raises an exception.</p>
<pre class="ruby"><span class="ruby-string">"123.45e1"</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-comment">#=> 1234.5</span>
<span class="ruby-string">"45.67 degrees"</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-comment">#=> 45.67</span>
<span class="ruby-string">"thx1138"</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-comment">#=> 0.0</span>
</pre>
<div class="method-source-code" id="to_f-source">
<pre>static VALUE
rb_str_to_f(VALUE str)
{
return DBL2NUM(rb_str_to_dbl(str, FALSE));
}</pre>
</div>
</div>
</div>
<div id="method-i-to_i" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
to_i(base=10) → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the result of interpreting leading characters in <em>str</em> as an integer base <em>base</em> (between 2 and 36). Extraneous characters past the end of a valid number are ignored. If there is not a valid number at the start of <em>str</em>, <code>0</code> is returned. This method never raises an exception when <em>base</em> is valid.</p>
<pre class="ruby"><span class="ruby-string">"12345"</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-comment">#=> 12345</span>
<span class="ruby-string">"99 red balloons"</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-comment">#=> 99</span>
<span class="ruby-string">"0a"</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-comment">#=> 0</span>
<span class="ruby-string">"0a"</span>.<span class="ruby-identifier">to_i</span>(<span class="ruby-value">16</span>) <span class="ruby-comment">#=> 10</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-comment">#=> 0</span>
<span class="ruby-string">"1100101"</span>.<span class="ruby-identifier">to_i</span>(<span class="ruby-value">2</span>) <span class="ruby-comment">#=> 101</span>
<span class="ruby-string">"1100101"</span>.<span class="ruby-identifier">to_i</span>(<span class="ruby-value">8</span>) <span class="ruby-comment">#=> 294977</span>
<span class="ruby-string">"1100101"</span>.<span class="ruby-identifier">to_i</span>(<span class="ruby-value">10</span>) <span class="ruby-comment">#=> 1100101</span>
<span class="ruby-string">"1100101"</span>.<span class="ruby-identifier">to_i</span>(<span class="ruby-value">16</span>) <span class="ruby-comment">#=> 17826049</span>
</pre>
<div class="method-source-code" id="to_i-source">
<pre>static VALUE
rb_str_to_i(int argc, VALUE *argv, VALUE str)
{
int base = 10;
if (rb_check_arity(argc, 0, 1) && (base = NUM2INT(argv[0])) < 0) {
rb_raise(rb_eArgError, "invalid radix %d", base);
}
return rb_str_to_inum(str, base, FALSE);
}</pre>
</div>
</div>
</div>
<div id="method-i-to_r" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
to_r → rational
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the result of interpreting leading characters in <code>str</code> as a rational. Leading whitespace and extraneous characters past the end of a valid number are ignored. Digit sequences can be separated by an underscore. If there is not a valid number at the start of <code>str</code>, zero is returned. This method never raises an exception.</p>
<pre class="ruby"><span class="ruby-string">' 2 '</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-comment">#=> (2/1)</span>
<span class="ruby-string">'300/2'</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-comment">#=> (150/1)</span>
<span class="ruby-string">'-9.2'</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-comment">#=> (-46/5)</span>
<span class="ruby-string">'-9.2e2'</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-comment">#=> (-920/1)</span>
<span class="ruby-string">'1_234_567'</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-comment">#=> (1234567/1)</span>
<span class="ruby-string">'21 June 09'</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-comment">#=> (21/1)</span>
<span class="ruby-string">'21/06/09'</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-comment">#=> (7/2)</span>
<span class="ruby-string">'BWV 1079'</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-comment">#=> (0/1)</span>
</pre>
<p>NOTE: “0.3”.to_r isn't the same as 0.3.to_r. The former is equivalent to “3/10”.to_r, but the latter isn't so.</p>
<pre class="ruby"><span class="ruby-string">"0.3"</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-operator">==</span> <span class="ruby-value">3</span><span class="ruby-operator">/</span><span class="ruby-value">10r</span> <span class="ruby-comment">#=> true</span>
<span class="ruby-value">0.3</span>.<span class="ruby-identifier">to_r</span> <span class="ruby-operator">==</span> <span class="ruby-value">3</span><span class="ruby-operator">/</span><span class="ruby-value">10r</span> <span class="ruby-comment">#=> false</span>
</pre>
<p>See also Kernel#Rational.</p>
<div class="method-source-code" id="to_r-source">
<pre>static VALUE
string_to_r(VALUE self)
{
VALUE num;
rb_must_asciicompat(self);
num = parse_rat(RSTRING_PTR(self), RSTRING_END(self), 0, TRUE);
if (RB_FLOAT_TYPE_P(num) && !FLOAT_ZERO_P(num))
rb_raise(rb_eFloatDomainError, "Infinity");
return num;
}</pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
to_s → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
to_str → str
</span>
</div>
<div class="method-description">
<p>Returns <code>self</code>.</p>
<p>If called on a subclass of <a href="String.html"><code>String</code></a>, converts the receiver to a <a href="String.html"><code>String</code></a> object.</p>
<div class="method-source-code" id="to_s-source">
<pre>static VALUE
rb_str_to_s(VALUE str)
{
if (rb_obj_class(str) != rb_cString) {
return str_duplicate(rb_cString, str);
}
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-to_str" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
to_str → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>self</code>.</p>
<p>If called on a subclass of <a href="String.html"><code>String</code></a>, converts the receiver to a <a href="String.html"><code>String</code></a> object.</p>
<div class="method-source-code" id="to_str-source">
<pre>static VALUE
rb_str_to_s(VALUE str)
{
if (rb_obj_class(str) != rb_cString) {
return str_duplicate(rb_cString, str);
}
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-to_sym" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
to_sym → symbol
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the <a href="Symbol.html"><code>Symbol</code></a> corresponding to <em>str</em>, creating the symbol if it did not previously exist. See <a href="Symbol.html#method-i-id2name"><code>Symbol#id2name</code></a>.</p>
<pre class="ruby"><span class="ruby-string">"Koala"</span>.<span class="ruby-identifier">intern</span> <span class="ruby-comment">#=> :Koala</span>
<span class="ruby-identifier">s</span> = <span class="ruby-string">'cat'</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-comment">#=> :cat</span>
<span class="ruby-identifier">s</span> <span class="ruby-operator">==</span> <span class="ruby-value">:cat</span> <span class="ruby-comment">#=> true</span>
<span class="ruby-identifier">s</span> = <span class="ruby-string">'@cat'</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-comment">#=> :@cat</span>
<span class="ruby-identifier">s</span> <span class="ruby-operator">==</span> <span class="ruby-value">:@cat</span> <span class="ruby-comment">#=> true</span>
</pre>
<p>This can also be used to create symbols that cannot be represented using the <code>:xxx</code> notation.</p>
<pre class="ruby"><span class="ruby-string">'cat and dog'</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-comment">#=> :"cat and dog"</span>
</pre>
<div class="method-source-code" id="to_sym-source">
<pre>VALUE
rb_str_intern(VALUE str)
{
#if USE_SYMBOL_GC
rb_encoding *enc, *ascii;
int type;
#else
ID id;
#endif
VALUE sym = lookup_str_sym(str);
if (sym) {
return sym;
}
#if USE_SYMBOL_GC
enc = rb_enc_get(str);
ascii = rb_usascii_encoding();
if (enc != ascii && sym_check_asciionly(str)) {
str = rb_str_dup(str);
rb_enc_associate(str, ascii);
OBJ_FREEZE(str);
enc = ascii;
}
else {
str = rb_str_dup(str);
OBJ_FREEZE(str);
}
str = rb_fstring(str);
type = rb_str_symname_type(str, IDSET_ATTRSET_FOR_INTERN);
if (type < 0) type = ID_JUNK;
return dsymbol_alloc(rb_cSymbol, str, enc, type);
#else
id = intern_str(str, 0);
return ID2SYM(id);
#endif
}</pre>
</div>
</div>
</div>
<div id="method-i-toeuc" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
String#toeuc → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>self</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 224</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toeuc</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">toeuc</span>(<span class="ruby-keyword">self</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">
String#tojis → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>self</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 218</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tojis</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">tojis</span>(<span class="ruby-keyword">self</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">
String#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 254</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tolocale</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">tolocale</span>(<span class="ruby-keyword">self</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">
String#tosjis → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>self</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 230</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tosjis</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">tosjis</span>(<span class="ruby-keyword">self</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">
String#toutf16 → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>self</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 242</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toutf16</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">toutf16</span>(<span class="ruby-keyword">self</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">
String#toutf32 → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>self</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 248</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toutf32</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">toutf32</span>(<span class="ruby-keyword">self</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">
String#toutf8 → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert <code>self</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 236</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">toutf8</span>; <span class="ruby-constant">Kconv</span>.<span class="ruby-identifier">toutf8</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tr" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
tr(from_str, to_str) → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a copy of <code>str</code> with the characters in <code>from_str</code> replaced by the corresponding characters in <code>to_str</code>. If <code>to_str</code> is shorter than <code>from_str</code>, it is padded with its last character in order to maintain the correspondence.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">'el'</span>, <span class="ruby-string">'ip'</span>) <span class="ruby-comment">#=> "hippo"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">'aeiou'</span>, <span class="ruby-string">'*'</span>) <span class="ruby-comment">#=> "h*ll*"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">'aeiou'</span>, <span class="ruby-string">'AA*'</span>) <span class="ruby-comment">#=> "hAll*"</span>
</pre>
<p>Both strings may use the <code>c1-c2</code> notation to denote ranges of characters, and <code>from_str</code> may start with a <code>^</code>, which denotes all characters except those listed.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">'a-y'</span>, <span class="ruby-string">'b-z'</span>) <span class="ruby-comment">#=> "ifmmp"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">'^aeiou'</span>, <span class="ruby-string">'*'</span>) <span class="ruby-comment">#=> "*e**o"</span>
</pre>
<p>The backslash character <code>\</code> can be used to escape <code>^</code> or <code>-</code> and is otherwise ignored unless it appears at the end of a range or the end of the <code>from_str</code> or <code>to_str</code>:</p>
<pre class="ruby"><span class="ruby-string">"hello^world"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">"\\^aeiou"</span>, <span class="ruby-string">"*"</span>) <span class="ruby-comment">#=> "h*ll**w*rld"</span>
<span class="ruby-string">"hello-world"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">"a\\-eo"</span>, <span class="ruby-string">"*"</span>) <span class="ruby-comment">#=> "h*ll**w*rld"</span>
<span class="ruby-string">"hello\r\nworld"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">"\r"</span>, <span class="ruby-string">""</span>) <span class="ruby-comment">#=> "hello\nworld"</span>
<span class="ruby-string">"hello\r\nworld"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">"\\r"</span>, <span class="ruby-string">""</span>) <span class="ruby-comment">#=> "hello\r\nwold"</span>
<span class="ruby-string">"hello\r\nworld"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">"\\\r"</span>, <span class="ruby-string">""</span>) <span class="ruby-comment">#=> "hello\nworld"</span>
<span class="ruby-string">"X['\\b']"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">"X\\"</span>, <span class="ruby-string">""</span>) <span class="ruby-comment">#=> "['b']"</span>
<span class="ruby-string">"X['\\b']"</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">"X-\\]"</span>, <span class="ruby-string">""</span>) <span class="ruby-comment">#=> "'b'"</span>
</pre>
<div class="method-source-code" id="tr-source">
<pre>static VALUE
rb_str_tr(VALUE str, VALUE src, VALUE repl)
{
str = rb_str_dup(str);
tr_trans(str, src, repl, 0);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-tr-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
tr!(from_str, to_str) → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Translates <em>str</em> in place, using the same rules as <a href="String.html#method-i-tr"><code>String#tr</code></a>. Returns <em>str</em>, or <code>nil</code> if no changes were made.</p>
<div class="method-source-code" id="tr-21-source">
<pre>static VALUE
rb_str_tr_bang(VALUE str, VALUE src, VALUE repl)
{
return tr_trans(str, src, repl, 0);
}</pre>
</div>
</div>
</div>
<div id="method-i-tr_s" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
tr_s(from_str, to_str) → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Processes a copy of <em>str</em> as described under <a href="String.html#method-i-tr"><code>String#tr</code></a>, then removes duplicate characters in regions that were affected by the translation.</p>
<pre class="ruby"><span class="ruby-string">"hello"</span>.<span class="ruby-identifier">tr_s</span>(<span class="ruby-string">'l'</span>, <span class="ruby-string">'r'</span>) <span class="ruby-comment">#=> "hero"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">tr_s</span>(<span class="ruby-string">'el'</span>, <span class="ruby-string">'*'</span>) <span class="ruby-comment">#=> "h*o"</span>
<span class="ruby-string">"hello"</span>.<span class="ruby-identifier">tr_s</span>(<span class="ruby-string">'el'</span>, <span class="ruby-string">'hx'</span>) <span class="ruby-comment">#=> "hhxo"</span>
</pre>
<div class="method-source-code" id="tr_s-source">
<pre>static VALUE
rb_str_tr_s(VALUE str, VALUE src, VALUE repl)
{
str = rb_str_dup(str);
tr_trans(str, src, repl, 1);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-tr_s-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
tr_s!(from_str, to_str) → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Performs <a href="String.html#method-i-tr_s"><code>String#tr_s</code></a> processing on <em>str</em> in place, returning <em>str</em>, or <code>nil</code> if no changes were made.</p>
<div class="method-source-code" id="tr_s-21-source">
<pre>static VALUE
rb_str_tr_s_bang(VALUE str, VALUE src, VALUE repl)
{
return tr_trans(str, src, repl, 1);
}</pre>
</div>
</div>
</div>
<div id="method-i-undump" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
undump → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an unescaped version of the string. This does the inverse of <a href="String.html#method-i-dump"><code>String#dump</code></a>.</p>
<pre class="ruby"><span class="ruby-string">"\"hello \\n ''\""</span>.<span class="ruby-identifier">undump</span> <span class="ruby-comment">#=> "hello \n ''"</span>
</pre>
<div class="method-source-code" id="undump-source">
<pre>static VALUE
str_undump(VALUE str)
{
const char *s = RSTRING_PTR(str);
const char *s_end = RSTRING_END(str);
rb_encoding *enc = rb_enc_get(str);
VALUE undumped = rb_enc_str_new(s, 0L, enc);
bool utf8 = false;
bool binary = false;
int w;
rb_must_asciicompat(str);
if (rb_str_is_ascii_only_p(str) == Qfalse) {
rb_raise(rb_eRuntimeError, "non-ASCII character detected");
}
if (!str_null_check(str, &w)) {
rb_raise(rb_eRuntimeError, "string contains null byte");
}
if (RSTRING_LEN(str) < 2) goto invalid_format;
if (*s != '"') goto invalid_format;
/* strip '"' at the start */
s++;
for (;;) {
if (s >= s_end) {
rb_raise(rb_eRuntimeError, "unterminated dumped string");
}
if (*s == '"') {
/* epilogue */
s++;
if (s == s_end) {
/* ascii compatible dumped string */
break;
}
else {
static const char force_encoding_suffix[] = ".force_encoding(\""; /* "\")" */
static const char dup_suffix[] = ".dup";
const char *encname;
int encidx;
ptrdiff_t size;
/* check separately for strings dumped by older versions */
size = sizeof(dup_suffix) - 1;
if (s_end - s > size && memcmp(s, dup_suffix, size) == 0) s += size;
size = sizeof(force_encoding_suffix) - 1;
if (s_end - s <= size) goto invalid_format;
if (memcmp(s, force_encoding_suffix, size) != 0) goto invalid_format;
s += size;
if (utf8) {
rb_raise(rb_eRuntimeError, "dumped string contained Unicode escape but used force_encoding");
}
encname = s;
s = memchr(s, '"', s_end-s);
size = s - encname;
if (!s) goto invalid_format;
if (s_end - s != 2) goto invalid_format;
if (s[0] != '"' || s[1] != ')') goto invalid_format;
encidx = rb_enc_find_index2(encname, (long)size);
if (encidx < 0) {
rb_raise(rb_eRuntimeError, "dumped string has unknown encoding name");
}
rb_enc_associate_index(undumped, encidx);
}
break;
}
if (*s == '\\') {
s++;
if (s >= s_end) {
rb_raise(rb_eRuntimeError, "invalid escape");
}
undump_after_backslash(undumped, &s, s_end, &enc, &utf8, &binary);
}
else {
rb_str_cat(undumped, s++, 1);
}
}
return undumped;
invalid_format:
rb_raise(rb_eRuntimeError, "invalid dumped string; not wrapped with '\"' nor '\"...\".force_encoding(\"...\")' form");
}</pre>
</div>
</div>
</div>
<div id="method-i-unicode_normalize" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
unicode_normalize(form=:nfc)
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Unicode Normalization—Returns a normalized form of <code>str</code>, using Unicode normalizations NFC, NFD, NFKC, or NFKD. The normalization form used is determined by <code>form</code>, which can be any of the four values <code>:nfc</code>, <code>:nfd</code>, <code>:nfkc</code>, or <code>:nfkd</code>. The default is <code>:nfc</code>.</p>
<p>If the string is not in a Unicode <a href="Encoding.html"><code>Encoding</code></a>, then an <a href="Exception.html"><code>Exception</code></a> is raised. In this context, 'Unicode Encoding' means any of UTF-8, UTF-16BE/LE, and UTF-32BE/LE, as well as GB18030, UCS_2BE, and UCS_4BE. Anything other than UTF-8 is implemented by converting to UTF-8, which makes it slower than UTF-8.</p>
<pre class="ruby"><span class="ruby-string">"a\u0300"</span>.<span class="ruby-identifier">unicode_normalize</span> <span class="ruby-comment">#=> "\u00E0"</span>
<span class="ruby-string">"a\u0300"</span>.<span class="ruby-identifier">unicode_normalize</span>(<span class="ruby-value">:nfc</span>) <span class="ruby-comment">#=> "\u00E0"</span>
<span class="ruby-string">"\u00E0"</span>.<span class="ruby-identifier">unicode_normalize</span>(<span class="ruby-value">:nfd</span>) <span class="ruby-comment">#=> "a\u0300"</span>
<span class="ruby-string">"\xE0"</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">'ISO-8859-1'</span>).<span class="ruby-identifier">unicode_normalize</span>(<span class="ruby-value">:nfd</span>)
<span class="ruby-comment">#=> Encoding::CompatibilityError raised</span>
</pre>
<div class="method-source-code" id="unicode_normalize-source">
<pre>static VALUE
rb_str_unicode_normalize(int argc, VALUE *argv, VALUE str)
{
return unicode_normalize_common(argc, argv, str, id_normalize);
}</pre>
</div>
</div>
</div>
<div id="method-i-unicode_normalize-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
unicode_normalize!(form=:nfc)
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Destructive version of <a href="String.html#method-i-unicode_normalize"><code>String#unicode_normalize</code></a>, doing Unicode normalization in place.</p>
<div class="method-source-code" id="unicode_normalize-21-source">
<pre>static VALUE
rb_str_unicode_normalize_bang(int argc, VALUE *argv, VALUE str)
{
return rb_str_replace(str, unicode_normalize_common(argc, argv, str, id_normalize));
}</pre>
</div>
</div>
</div>
<div id="method-i-unicode_normalized-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
unicode_normalized?(form=:nfc)
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Checks whether <code>str</code> is in Unicode normalization form <code>form</code>, which can be any of the four values <code>:nfc</code>, <code>:nfd</code>, <code>:nfkc</code>, or <code>:nfkd</code>. The default is <code>:nfc</code>.</p>
<p>If the string is not in a Unicode <a href="Encoding.html"><code>Encoding</code></a>, then an <a href="Exception.html"><code>Exception</code></a> is raised. For details, see <a href="String.html#method-i-unicode_normalize"><code>String#unicode_normalize</code></a>.</p>
<pre class="ruby"><span class="ruby-string">"a\u0300"</span>.<span class="ruby-identifier">unicode_normalized?</span> <span class="ruby-comment">#=> false</span>
<span class="ruby-string">"a\u0300"</span>.<span class="ruby-identifier">unicode_normalized?</span>(<span class="ruby-value">:nfd</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"\u00E0"</span>.<span class="ruby-identifier">unicode_normalized?</span> <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"\u00E0"</span>.<span class="ruby-identifier">unicode_normalized?</span>(<span class="ruby-value">:nfd</span>) <span class="ruby-comment">#=> false</span>
<span class="ruby-string">"\xE0"</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">'ISO-8859-1'</span>).<span class="ruby-identifier">unicode_normalized?</span>
<span class="ruby-comment">#=> Encoding::CompatibilityError raised</span>
</pre>
<div class="method-source-code" id="unicode_normalized-3F-source">
<pre>static VALUE
rb_str_unicode_normalized_p(int argc, VALUE *argv, VALUE str)
{
return unicode_normalize_common(argc, argv, str, id_normalized_p);
}</pre>
</div>
</div>
</div>
<div id="method-i-unpack" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
unpack(format) → anArray
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Decodes <em>str</em> (which may contain binary data) according to the format string, returning an array of each value extracted. The format string consists of a sequence of single-character directives, summarized in the table at the end of this entry. Each directive may be followed by a number, indicating the number of times to repeat with this directive. An asterisk (“<code>*</code>'') will use up all remaining elements. The directives <code>sSiIlL</code> may each be followed by an underscore (“<code>_</code>'') or exclamation mark (“<code>!</code>'') to use the underlying platform's native size for the specified type; otherwise, it uses a platform-independent consistent size. Spaces are ignored in the format string. See also <a href="String.html#method-i-unpack1"><code>String#unpack1</code></a>, <a href="Array.html#method-i-pack"><code>Array#pack</code></a>.</p>
<pre class="ruby"><span class="ruby-string">"abc \0\0abc \0\0"</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'A6Z6'</span>) <span class="ruby-comment">#=> ["abc", "abc "]</span>
<span class="ruby-string">"abc \0\0"</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'a3a3'</span>) <span class="ruby-comment">#=> ["abc", " \000\000"]</span>
<span class="ruby-string">"abc \0abc \0"</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'Z*Z*'</span>) <span class="ruby-comment">#=> ["abc ", "abc "]</span>
<span class="ruby-string">"aa"</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'b8B8'</span>) <span class="ruby-comment">#=> ["10000110", "01100001"]</span>
<span class="ruby-string">"aaa"</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'h2H2c'</span>) <span class="ruby-comment">#=> ["16", "61", 97]</span>
<span class="ruby-string">"\xfe\xff\xfe\xff"</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'sS'</span>) <span class="ruby-comment">#=> [-2, 65534]</span>
<span class="ruby-string">"now=20is"</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'M*'</span>) <span class="ruby-comment">#=> ["now is"]</span>
<span class="ruby-string">"whole"</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'xax2aX2aX1aX2a'</span>) <span class="ruby-comment">#=> ["h", "e", "l", "l", "o"]</span>
</pre>
<p>This table summarizes the various formats and the Ruby classes returned by each.</p>
<pre>Integer | |
Directive | Returns | Meaning
------------------------------------------------------------------
C | Integer | 8-bit unsigned (unsigned char)
S | Integer | 16-bit unsigned, native endian (uint16_t)
L | Integer | 32-bit unsigned, native endian (uint32_t)
Q | Integer | 64-bit unsigned, native endian (uint64_t)
J | Integer | pointer width unsigned, native endian (uintptr_t)
| |
c | Integer | 8-bit signed (signed char)
s | Integer | 16-bit signed, native endian (int16_t)
l | Integer | 32-bit signed, native endian (int32_t)
q | Integer | 64-bit signed, native endian (int64_t)
j | Integer | pointer width signed, native endian (intptr_t)
| |
S_ S! | Integer | unsigned short, native endian
I I_ I! | Integer | unsigned int, native endian
L_ L! | Integer | unsigned long, native endian
Q_ Q! | Integer | unsigned long long, native endian (ArgumentError
| | if the platform has no long long type.)
J! | Integer | uintptr_t, native endian (same with J)
| |
s_ s! | Integer | signed short, native endian
i i_ i! | Integer | signed int, native endian
l_ l! | Integer | signed long, native endian
q_ q! | Integer | signed long long, native endian (ArgumentError
| | if the platform has no long long type.)
j! | Integer | intptr_t, native endian (same with j)
| |
S> s> S!> s!> | Integer | same as the directives without ">" except
L> l> L!> l!> | | big endian
I!> i!> | |
Q> q> Q!> q!> | | "S>" is same as "n"
J> j> J!> j!> | | "L>" is same as "N"
| |
S< s< S!< s!< | Integer | same as the directives without "<" except
L< l< L!< l!< | | little endian
I!< i!< | |
Q< q< Q!< q!< | | "S<" is same as "v"
J< j< J!< j!< | | "L<" is same as "V"
| |
n | Integer | 16-bit unsigned, network (big-endian) byte order
N | Integer | 32-bit unsigned, network (big-endian) byte order
v | Integer | 16-bit unsigned, VAX (little-endian) byte order
V | Integer | 32-bit unsigned, VAX (little-endian) byte order
| |
U | Integer | UTF-8 character
w | Integer | BER-compressed integer (see Array.pack)
Float | |
Directive | Returns | Meaning
-----------------------------------------------------------------
D d | Float | double-precision, native format
F f | Float | single-precision, native format
E | Float | double-precision, little-endian byte order
e | Float | single-precision, little-endian byte order
G | Float | double-precision, network (big-endian) byte order
g | Float | single-precision, network (big-endian) byte order
String | |
Directive | Returns | Meaning
-----------------------------------------------------------------
A | String | arbitrary binary string (remove trailing nulls and ASCII spaces)
a | String | arbitrary binary string
Z | String | null-terminated string
B | String | bit string (MSB first)
b | String | bit string (LSB first)
H | String | hex string (high nibble first)
h | String | hex string (low nibble first)
u | String | UU-encoded string
M | String | quoted-printable, MIME encoding (see RFC2045)
m | String | base64 encoded string (RFC 2045) (default)
| | base64 encoded string (RFC 4648) if followed by 0
P | String | pointer to a structure (fixed-length string)
p | String | pointer to a null-terminated string
Misc. | |
Directive | Returns | Meaning
-----------------------------------------------------------------
@ | --- | skip to the offset given by the length argument
X | --- | skip backward one byte
x | --- | skip forward one byte</pre>
<p>HISTORY</p>
<ul><li>
<p>J, J! j, and j! are available since Ruby 2.3.</p>
</li><li>
<p>Q_, Q!, q_, and q! are available since Ruby 2.1.</p>
</li><li>
<p>I!<, i!<, I!>, and i!> are available since Ruby 1.9.3.</p>
</li></ul>
<div class="method-source-code" id="unpack-source">
<pre><span class="ruby-comment"># File pack.rb, line 256</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unpack</span>(<span class="ruby-identifier">fmt</span>)
<span class="ruby-identifier">__builtin_pack_unpack</span>(<span class="ruby-identifier">fmt</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-unpack1" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
unpack1(format) → obj
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Decodes <em>str</em> (which may contain binary data) according to the format string, returning the first value extracted. See also <a href="String.html#method-i-unpack"><code>String#unpack</code></a>, <a href="Array.html#method-i-pack"><code>Array#pack</code></a>.</p>
<p>Contrast with <a href="String.html#method-i-unpack"><code>String#unpack</code></a>:</p>
<pre class="ruby"><span class="ruby-string">"abc \0\0abc \0\0"</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'A6Z6'</span>) <span class="ruby-comment">#=> ["abc", "abc "]</span>
<span class="ruby-string">"abc \0\0abc \0\0"</span>.<span class="ruby-identifier">unpack1</span>(<span class="ruby-string">'A6Z6'</span>) <span class="ruby-comment">#=> "abc"</span>
</pre>
<p>In that case data would be lost but often it's the case that the array only holds one value, especially when unpacking binary data. For instance:</p>
<p>“xffx00x00x00”.unpack(“l”) #=> [255] “xffx00x00x00”.unpack1(“l”) #=> 255</p>
<p>Thus unpack1 is convenient, makes clear the intention and signals the expected return value to those reading the code.</p>
<div class="method-source-code" id="unpack1-source">
<pre><span class="ruby-comment"># File pack.rb, line 280</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unpack1</span>(<span class="ruby-identifier">fmt</span>)
<span class="ruby-identifier">__builtin_pack_unpack1</span>(<span class="ruby-identifier">fmt</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-upcase" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
upcase → new_str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
upcase([options]) → new_str
</span>
</div>
<div class="method-description">
<p>Returns a copy of <em>str</em> with all lowercase letters replaced with their uppercase counterparts.</p>
<p>See <a href="String.html#method-i-downcase"><code>String#downcase</code></a> for meaning of <code>options</code> and use with different encodings.</p>
<pre class="ruby"><span class="ruby-string">"hEllO"</span>.<span class="ruby-identifier">upcase</span> <span class="ruby-comment">#=> "HELLO"</span>
</pre>
<div class="method-source-code" id="upcase-source">
<pre>static VALUE
rb_str_upcase(int argc, VALUE *argv, VALUE str)
{
rb_encoding *enc;
OnigCaseFoldType flags = ONIGENC_CASE_UPCASE;
VALUE ret;
flags = check_case_options(argc, argv, flags);
enc = str_true_enc(str);
if (case_option_single_p(flags, enc, str)) {
ret = rb_str_new_with_class(str, RSTRING_PTR(str), RSTRING_LEN(str));
str_enc_copy(ret, str);
upcase_single(ret);
}
else if (flags&ONIGENC_CASE_ASCII_ONLY) {
ret = rb_str_new_with_class(str, 0, RSTRING_LEN(str));
rb_str_ascii_casemap(str, ret, &flags, enc);
}
else {
ret = rb_str_casemap(str, &flags, enc);
}
return ret;
}</pre>
</div>
</div>
</div>
<div id="method-i-upcase-21" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
upcase! → str or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
upcase!([options]) → str or nil
</span>
</div>
<div class="method-description">
<p>Upcases the contents of <em>str</em>, returning <code>nil</code> if no changes were made.</p>
<p>See <a href="String.html#method-i-downcase"><code>String#downcase</code></a> for meaning of <code>options</code> and use with different encodings.</p>
<div class="method-source-code" id="upcase-21-source">
<pre>static VALUE
rb_str_upcase_bang(int argc, VALUE *argv, VALUE str)
{
rb_encoding *enc;
OnigCaseFoldType flags = ONIGENC_CASE_UPCASE;
flags = check_case_options(argc, argv, flags);
str_modify_keep_cr(str);
enc = str_true_enc(str);
if (case_option_single_p(flags, enc, str)) {
if (upcase_single(str))
flags |= ONIGENC_CASE_MODIFIED;
}
else if (flags&ONIGENC_CASE_ASCII_ONLY)
rb_str_ascii_casemap(str, str, &flags, enc);
else
str_shared_replace(str, rb_str_casemap(str, &flags, enc));
if (ONIGENC_CASE_MODIFIED&flags) return str;
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-upto" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
upto(other_str, exclusive=false) {|s| block } → str
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
upto(other_str, exclusive=false) → an_enumerator
</span>
</div>
<div class="method-description">
<p>Iterates through successive values, starting at <em>str</em> and ending at <em>other_str</em> inclusive, passing each value in turn to the block. The <a href="String.html#method-i-succ"><code>String#succ</code></a> method is used to generate each value. If optional second argument exclusive is omitted or is false, the last value will be included; otherwise it will be excluded.</p>
<p>If no block is given, an enumerator is returned instead.</p>
<pre class="ruby"><span class="ruby-string">"a8"</span>.<span class="ruby-identifier">upto</span>(<span class="ruby-string">"b6"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">print</span> <span class="ruby-identifier">s</span>, <span class="ruby-string">' '</span> }
<span class="ruby-keyword">for</span> <span class="ruby-identifier">s</span> <span class="ruby-keyword">in</span> <span class="ruby-string">"a8"</span><span class="ruby-operator">..</span><span class="ruby-string">"b6"</span>
<span class="ruby-identifier">print</span> <span class="ruby-identifier">s</span>, <span class="ruby-string">' '</span>
<span class="ruby-keyword">end</span>
</pre>
<p><em>produces:</em></p>
<pre class="ruby"><span class="ruby-identifier">a8</span> <span class="ruby-identifier">a9</span> <span class="ruby-identifier">b0</span> <span class="ruby-identifier">b1</span> <span class="ruby-identifier">b2</span> <span class="ruby-identifier">b3</span> <span class="ruby-identifier">b4</span> <span class="ruby-identifier">b5</span> <span class="ruby-identifier">b6</span>
<span class="ruby-identifier">a8</span> <span class="ruby-identifier">a9</span> <span class="ruby-identifier">b0</span> <span class="ruby-identifier">b1</span> <span class="ruby-identifier">b2</span> <span class="ruby-identifier">b3</span> <span class="ruby-identifier">b4</span> <span class="ruby-identifier">b5</span> <span class="ruby-identifier">b6</span>
</pre>
<p>If <em>str</em> and <em>other_str</em> contains only ascii numeric characters, both are recognized as decimal numbers. In addition, the width of string (e.g. leading zeros) is handled appropriately.</p>
<pre class="ruby"><span class="ruby-string">"9"</span>.<span class="ruby-identifier">upto</span>(<span class="ruby-string">"11"</span>).<span class="ruby-identifier">to_a</span> <span class="ruby-comment">#=> ["9", "10", "11"]</span>
<span class="ruby-string">"25"</span>.<span class="ruby-identifier">upto</span>(<span class="ruby-string">"5"</span>).<span class="ruby-identifier">to_a</span> <span class="ruby-comment">#=> []</span>
<span class="ruby-string">"07"</span>.<span class="ruby-identifier">upto</span>(<span class="ruby-string">"11"</span>).<span class="ruby-identifier">to_a</span> <span class="ruby-comment">#=> ["07", "08", "09", "10", "11"]</span>
</pre>
<div class="method-source-code" id="upto-source">
<pre>static VALUE
rb_str_upto(int argc, VALUE *argv, VALUE beg)
{
VALUE end, exclusive;
rb_scan_args(argc, argv, "11", &end, &exclusive);
RETURN_ENUMERATOR(beg, argc, argv);
return rb_str_upto_each(beg, end, RTEST(exclusive), str_upto_i, Qnil);
}</pre>
</div>
</div>
</div>
<div id="method-i-valid_encoding-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
valid_encoding? → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true for a string which is encoded correctly.</p>
<pre class="ruby"><span class="ruby-string">"\xc2\xa1"</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">"UTF-8"</span>).<span class="ruby-identifier">valid_encoding?</span> <span class="ruby-comment">#=> true</span>
<span class="ruby-string">"\xc2"</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">"UTF-8"</span>).<span class="ruby-identifier">valid_encoding?</span> <span class="ruby-comment">#=> false</span>
<span class="ruby-string">"\x80"</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">"UTF-8"</span>).<span class="ruby-identifier">valid_encoding?</span> <span class="ruby-comment">#=> false</span>
</pre>
<div class="method-source-code" id="valid_encoding-3F-source">
<pre>static VALUE
rb_str_valid_encoding_p(VALUE str)
{
int cr = rb_enc_str_coderange(str);
return cr == ENC_CODERANGE_BROKEN ? Qfalse : Qtrue;
}</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>