Ruby class String | Chautauqua

Creating

# str = 'Dig it'

newstr = String.new('Dig it') # Dig it Documentation Playground

str = String.new('Dig it')

Dig it

try_convertString.try_convert(42) # nil (String if it responds to to_str) Documentation Playground

[String.try_convert('Dig it'), String.try_convert(42)].inspect

["Dig it", nil]

Querying

Counts

length (alias size)str.length # 6 Documentation Playground

str = 'Dig it'
str.length

6

bytesize"Dig øt".bytesize # 7 Documentation Playground

str = 'Dig øt'
str.bytesize

7

countstr.count('i') # 2 Documentation Playground

str = 'Dig it'
str.count('i')

2

empty?str.empty? # false Documentation Playground

str = 'Dig it'
str.empty?

false

Substrings

=~str =~ /g/ # 2 Documentation Playground

str = 'Dig it'
str =~ /g/

2

indexstr.index('i') # 1 Documentation Playground

str = 'Dig it'
str.index('i')

1

rindexstr.rindex('i') # 4 Documentation Playground

str = 'Dig it'
str.rindex('i')

4

byteindexstr.byteindex('i') # 1 Documentation Playground

str = 'Dig it'
str.byteindex('i')

1

byterindexstr.byterindex('i') # 4 Documentation Playground

str = 'Dig it'
str.byterindex('i')

4

include?str.include?('ig') # true Documentation Playground

str = 'Dig it'
str.include?('ig')

true

matchstr.match('i') # i Documentation Playground

str = 'Dig it'
str.match('i').to_s

i

match?str.match?(/i/) # true Documentation Playground

str = 'Dig it'
str.match?(/i/)

true

start_with?str.start_with?('Di') # true Documentation Playground

str = 'Dig it'
str.start_with?('Di')

true

end_with?str.end_with?('it') # true Documentation Playground

str = 'Dig it'
str.end_with?('it')

true

Encodings

encodingstr.encoding # #<Encoding:UTF-8> Documentation Playground

str = 'Dig it'
str.encoding.to_s

UTF-8

unicode_normalized?"\u00E0".unicode_normalized? # true Documentation Playground

"\u00E0".unicode_normalized?

true

valid_encoding?"Mañana".valid_encoding? # true Documentation Playground

"Mañana".valid_encoding?

true

ascii_only?"Mañana".ascii_only? # false Documentation Playground

"Mañana".ascii_only?

false

Other

sumstr.sum # 529 Documentation Playground

str = 'Dig it'
str.sum

529

hashstr.hash # 6345789 (differs per session) Documentation Playground

str = 'Dig it'
str.hash

Comparing

== (alias ===)str == 'foo' # false Documentation Playground

'a' == 'b'

false

eql?str.eql?('foo') # false Documentation Playground

'a'.eql?('b')

false

<=>'a'<=>'b'; 'a'<=>'a'; 'b'<=>'a' # -1;0;1 Documentation Playground

'a'<=>'b'

-1

casecmp'a'.casecmp('B') # -1 (Ignoring case) Documentation Playground

'a'.casecmp('B')

-1

casecmp?'a'.casecmp?('B') # false (Ignoring case) Documentation Playground

'a'.casecmp?('B')

false

Modifying (modifies self)

Insertion

insertstr.insert(4, 'more of ') # Dig more of it Documentation Playground

str = 'Dig it'
str.insert(4, 'more of ')

Dig more of it

<<str << ' now'; str << 33 # Dig it now! Documentation Playground

str = 'Dig it'
str << 33

Dig it!

append_as_bytes''.append_as_bytes(33, 97) # Dig it!a Documentation Playground

''.append_as_bytes(56, 33)

8!

prependstr.prepend('Go! ') # Go! Dig it Documentation Playground

str = 'Dig it'
str.prepend('Go! ')

Go! Dig it

Substitution

bytesplicestr.bytesplice(0, 3, 'Make') # Make it Documentation Playground

str = 'Dig it'
str.bytesplice(0, 3, 'Make')

Make it

setbytestr.setbyte(2, 129) # Di\x81 it Documentation Playground

str = 'Dig it'
str.setbyte(2, 33); str

Di! it

replacestr.replace('Brand new') # Brand new Documentation Playground

str = 'Dig it'
str.replace('Brand new')

Brand new

[]=str[0, 3] = 'Make' # Make it Documentation Playground

str = 'Dig it'
str[0, 3] = 'Make'; str

Make it

! See non-bang methods in 'Converting to New String' for:

sub! gsub! succ! reverse! tr! tr_s!

Casing

! See non-bang methods in 'Converting to New String' for:

capitalize! downcase! upcase! swapcase!

Encoding

force_encodingstr.force_encoding('ascii') # <…:US-ASCII> Documentation Playground

str = 'Dig it'
str.force_encoding('ascii'); str.encoding.to_s

US-ASCII

! See non-bang methods in 'Converting to New String' for:

encode! unicode_normalize! scrub!

Deletion

clearstr.clear # "" Documentation Playground

str = 'Dig it'
str.clear

! See non-bang methods in 'Converting to New String' for:

delete! delete_prefix! delete_suffix! strip! lstrip! rstrip! chomp! chop! squeeze! slice!

Converting to New String

Extension

*'Hi' * 3 # HiHiHi Documentation Playground

'Hi' * 3

HiHiHi

+'Hi' + ' there' # Hi there Documentation Playground

'Hi ' + 'there'

Hi there

center'Hi'.center(6) # ' Hi ' Documentation Playground

'Hi'.center(6, '-')

--Hi--

concat'Hi'.concat(33, 'there') # Hi!there Documentation Playground

'Hi'.concat(33, 'there')

Hi!there

ljust'Hi'.ljust(6) # 'Hi ' Documentation Playground

'Hi'.ljust(6, '-')

Hi----

rjust'Hi'.rjust(6, '-') # '----Hi' Documentation Playground

'Hi'.rjust(6, '-')

----Hi

Encoding

bs="\x99";s.b.encoding # BINARY (ASCII-8BIT) Documentation Playground

s="\x99"
s.b.encoding.to_s

ASCII-8BIT

scrub!"foo\x81\x81bar".scrub # foo��bar Documentation Playground

"foo\x81\x81bar".scrub

foo��bar

unicode_normalize!"\u00E9".unicode_normalize # é Documentation Playground

"\u00E9".unicode_normalize

é

encode!str.encode # str.encoding #<Encoding:UTF-8> Documentation Playground

str = 'Dig it'
str.encode; str.encoding.to_s

UTF-8

Substitution

dump'hi'.dump # "\"hi\"" Documentation Playground

'hi'.dump.inspect

"\"hi\""

undump"\"hi\"".undump # "hi" Documentation Playground

"\"hi\"".undump

hi

sub!str.sub('Dig', 'Change') # Change it Documentation Playground

str = 'Dig it'
str.sub('Dig', 'Change')

Change it

gsub!str.gsub('i', 'o') # Dog ot Documentation Playground

str = 'Dig it'
str.gsub('i', 'o')

Dog ot

next (alias succ)!str.next # Dig iu (increment character) Documentation Playground

str = 'Dig it'
str.next

Dig iu

reverse!str.reverse # ti giD Documentation Playground

str = 'Dig it'
str.reverse

ti giD

tr!str.tr('it','ol') # Dog ol Documentation Playground

str = 'Dig it'
str.tr('it','ol')

Dog ol

tr_s!'Snoopy'.tr_s('o','-') # Sn-py (squeezes) Documentation Playground

'Snoopy'.tr_s('o','-')

Sn-py

%'%04x' % 32 # "0020" Documentation Playground

'%04x' % 32

0020

Casing

capitalize!'nice'.capitalize # Nice Documentation Playground

str = 'nice'
str.capitalize

Nice

downcase!'CLASS'.downcase # class Documentation Playground

str = 'CLASS'
str.downcase

class

upcase!str.upcase # DIG IT Documentation Playground

str = 'Dig it'
str.upcase

DIG IT

swapcase!str.swapcase # dIG IT Documentation Playground

str = 'Dig it'
str.swapcase

dIG IT

Deletion

delete!str.delete('i') # 'Dg t' Documentation Playground

str = 'Dig it'
str.delete('i')

Dg t

delete_prefix!str.delete_prefix('Di') # g it Documentation Playground

str = 'Dig it'
str.delete_prefix('Di')

g it

delete_suffix!str.delete_suffix(' it') # Dig Documentation Playground

str = 'Dig it'
str.delete_suffix(' it')

Dig

strip!' Dig it '.strip # 'Dig it' Documentation Playground

str = ' Dig it '
str.strip.inspect

"Dig it"

lstrip!' Dig it '.lstrip # 'Dig it ' Documentation Playground

str = ' Dig it '
str.lstrip.inspect

"Dig it "

rstrip!' Dig it '.rstrip # ' Dig it' Documentation Playground

str = ' Dig it '
str.rstrip.inspect

" Dig it"

chomp!"Dig it\n\n".chomp('') # 'Dig it' Documentation Playground

"Dig it\n\n".chomp('').inspect

"Dig it"

chop!"Dig it\r\n".chop # 'Dig it' Documentation Playground

"Dig it\r\n".chop.inspect

"Dig it"

squeeze!'Diig iiit'.squeeze('i') # Dig it Documentation Playground

"Dig iiit".squeeze('i').inspect

"Dig it"

slice!str.slice(2); str.slice(1,4) # g; ig i Documentation Playground

str = 'Dig it'
str.slice(2)

g

[] (alias slice)str[2]; str[1,4] # g; ig i Documentation Playground

str = 'Dig it'
str[2]

g

byteslicestr.byteslice(2) # g Documentation Playground

str = 'Dig it'
str.byteslice(2)

g

chrstr.chr # D (first character) Documentation Playground

str = 'Dig it'
str.chr

D

Duplication

to_s (alias to_str)str.to_s # Dig it (self) Documentation Playground

str = 'Dig it'
str.to_s.equal?(str)

true

+@ (alias dup)+'Dig it' # Dig it (unfrozen) Documentation Playground

(+'Dig it'.freeze).frozen?

false

-@ (alias dedup)-'Dig it' # Dig it (frozen) Documentation Playground

(-'Dig it').frozen?

true

freezestr.freeze # Dig it (now frozen) Documentation Playground

str = +'Dig it'
str.freeze
str.frozen?

true

Converting to Non-String

Characters, Bytes, and Clusters

bytes'Olé'.bytes # [79,108,195,169] Documentation Playground

'Olé'.bytes

[79, 108, 195, 169]

chars'Olé'.chars # ['O','l','é'] Documentation Playground

'Olé'.chars

["O", "l", "é"]

codepoints'Olé'.codepoints # [79,108,233] Documentation Playground

'Olé'.codepoints

[79, 108, 233]

getbyte'Olé'.getbyte(0) # 79 Documentation Playground

'Olé'.getbyte(0)

79

grapheme_clusters'Olé'.grapheme_clusters # ['O','l','é'] Documentation Playground

'Olé'.grapheme_clusters

["O", "l", "é"]

Splitting

lines"L1\nL2".lines # ['L1\n','L2'] Documentation Playground

"L1\nL2".lines

["L1\n", "L2"]

partitionstr.partition(/i/) # ['D','i','g it'] Documentation Playground

str = 'Dig it'
str.partition(/i/)

["D", "i", "g it"]

rpartitionstr.rpartition(/i/) # ['Dig ','i','t'] Documentation Playground

str = 'Dig it'
str.rpartition(/i/)

["Dig ", "i", "t"]

splitstr.split; str.split(' ') # ['Dig','it'] Documentation Playground

str = 'Dig it'
str.split(' ')

["Dig", "it"]

Matching

scanstr.scan(/\w+/) # ['Dig','it'] Documentation Playground

str = 'Dig it'
str.scan(/\w+/)

["Dig", "it"]

unpack'AB!*'.unpack('CCCC') # [65,66,33,42] Documentation Playground

'AB!*'.unpack('CCCC')

[65, 66, 33, 42]

unpack1'A'.unpack1('C') # 65 Documentation Playground

'A'.unpack1('C')

65

Numerics

hex'ff'.hex # 255 Documentation Playground

'ff'.hex

255

oct'555'.oct # 365 Documentation Playground

'555'.oct

365

ord'!'.ord # 33 Documentation Playground

'!'.ord

33

to_c'2+3i'.to_c.rect # [2,3] Documentation Playground

'2+3i'.to_c.rect

[2, 3]

to_i'66abc'.to_i # 66 Documentation Playground

'66abc'.to_i

66

to_f'66abc'.to_f # 66.0 Documentation Playground

'66abc'.to_f.inspect

66.0

to_r'0.25'.to_r # (1/4) Documentation Playground

'0.25'.to_r.inspect

(1/4)

Strings and Symbols

inspectstr.inspect # "\"Dig it\"" Documentation Playground

str = 'Dig it'
str.inspect

"Dig it"

to_sym (alias intern)'dig'.to_sym # :dig Documentation Playground

'dig'.to_sym.inspect

:dig

Iterating

# a=[]; s='ok\u0301' (é as e + combining accent)

each_bytes.each_byte{|b|a<<b} # [111,107,101,204,129] Documentation Playground

a=[]; s="oke\u0301!".each_byte{|b| a<<b}; a.inspect

[111, 107, 101, 204, 129, 33]

each_chars.each_char{|b|a<<b} # ['o','k','e','́'] Documentation Playground

a=[]; s="oke\u0301!".each_char{|b| a<<b}; a.inspect

["o", "k", "e", "́", "!"]

each_codepoints.each_codepoint{|b|a<<b} # [111,107,101,769] Documentation Playground

a=[]; s="oke\u0301!".each_codepoint{|b| a<<b}; a.inspect

[111, 107, 101, 769, 33]

each_grapheme_clusters.each_grapheme_cluster{…} # ['o','k','é'] (e + accent = 1 cluster) Documentation Playground

a=[]; s="oke\u0301!".each_grapheme_cluster{|b| a<<b}; a.inspect

["o", "k", "é", "!"]

each_line"L1\nL2".each_line{|l|a<<l} # ['L1\n','L2'] Documentation Playground

a=[]; "L1\nL2".each_line{|l|a<<l}; a.inspect

["L1\n", "L2"]

upto'a'.upto('d') # ['a','b','c','d'] Documentation Playground

'a'.upto('d').to_a

["a", "b", "c", "d"]

Ruby class String interactive

Creating

Querying

Counts

Substrings

Encodings

Other

Comparing

Modifying (modifies self)

Insertion

Substitution

Casing

Encoding

Deletion

Converting to New String

Extension

Encoding

Substitution

Casing

Deletion

Duplication

Converting to Non-String

Characters, Bytes, and Clusters

Splitting

Matching

Numerics

Strings and Symbols

Iterating