diff options
author | Burdette Lamar <BurdetteLamar@Yahoo.com> | 2022-03-31 15:09:25 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-03-31 15:09:25 -0500 |
commit | 056b7a86335f38618c1749674a11e838de7c3c12 (patch) | |
tree | b6c0eaabec11b7377c081b274e32ebeff04d2c86 /doc/string/force_encoding.rdoc | |
parent | bb037f6d8639b7d36ef263ca24d4117d725e71ef (diff) | |
download | ruby-056b7a86335f38618c1749674a11e838de7c3c12.tar.gz |
[DOC] Enhanced RDoc for String (#5742)
Treats:
#force_encoding
#b
#valid_encoding?
#ascii_only?
#scrub
#scrub!
#unicode_normalized?
Plus a couple of minor tweaks.
Diffstat (limited to 'doc/string/force_encoding.rdoc')
-rw-r--r-- | doc/string/force_encoding.rdoc | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/string/force_encoding.rdoc b/doc/string/force_encoding.rdoc new file mode 100644 index 0000000000..fd9615caaa --- /dev/null +++ b/doc/string/force_encoding.rdoc @@ -0,0 +1,20 @@ +Changes the encoding of +self+ to +encoding+, +which may be a string encoding name or an Encoding object; +returns self: + + s = 'łał' + s.bytes # => [197, 130, 97, 197, 130] + s.encoding # => #<Encoding:UTF-8> + s.force_encoding('ascii') # => "\xC5\x82a\xC5\x82" + s.encoding # => #<Encoding:US-ASCII> + +Does not change the underlying bytes: + + s.bytes # => [197, 130, 97, 197, 130] + +Makes the change even if the given +encoding+ is invalid +for +self+ (as is the change above): + + s.valid_encoding? # => false + s.force_encoding(Encoding::UTF_8) # => "łał" + s.valid_encoding? # => true |