End of Life Ruby 3.0 has reached end of life and gets no more fixes. Switch to Ruby 4.0 →

instance method

String#each_grapheme_cluster

str.each_grapheme_cluster {|cstr| block } → str

str.each_grapheme_cluster → an_enumerator

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);
}

Passes each grapheme cluster in str to the given block, or returns an enumerator if no block is given. Unlike String#each_char, this enumerates by grapheme clusters defined by Unicode Standard Annex #29 unicode.org/reports/tr29/

Example

"a\u0300".each_char.to_a.size #=> 2
"a\u0300".each_grapheme_cluster.to_a.size #=> 1

Ruby version changes

3.0
- The following methods now return or yield String instances instead of subclass instances when called on subclass instances: [Bug #10845]

See also #each_codepoint #each_line #each_char #empty? also in 4.1 · 4.0 · 3.4 · 3.3 · 3.2 · 3.1

‹ prev#each_codepoint next ›#each_line