diff --git a/doc/string.rb b/doc/string.rb index 617cccc7820a1a..185dcee71cd432 100644 --- a/doc/string.rb +++ b/doc/string.rb @@ -458,8 +458,7 @@ # # _Substitution_ # -# - #dump: Returns a copy of +self+ with all non-printing characters replaced by \xHH notation -# and all special characters escaped. +# - #dump: Returns a printable version of +self+, enclosed in double-quotes. # - #undump: Returns a copy of +self+ with all \xNN notations replaced by \uNNNN notations # and all escaped characters unescaped. # - #sub: Returns a copy of +self+ with the first substring matching a given pattern diff --git a/doc/string/dump.rdoc b/doc/string/dump.rdoc new file mode 100644 index 00000000000000..20dca771f7ce53 --- /dev/null +++ b/doc/string/dump.rdoc @@ -0,0 +1,45 @@ +Returns a printable version of +self+, enclosed in double-quotes: + + 'hello'.dump # => "\"hello\"" + 'тест'.dump # => "\"\\u0442\\u0435\\u0441\\u0442\"" + 'こんにちは'.dump # => "\"\\u3053\\u3093\\u306B\\u3061\\u306F\"" + +Certain special characters are rendered with escapes: + + '"'.dump # => "\"\\\"\"" + '\\'.dump # => "\"\\\\\"" + +Non-printing characters are rendered with escapes: + + s = '' + s << 7 # Alarm (bell). + s << 8 # Back space. + s << 9 # Horizontal tab. + s << 10 # Line feed. + s << 11 # Vertical tab. + s << 12 # Form feed. + s << 13 # Carriage return. + s # => "\a\b\t\n\v\f\r" + s.dump # => "\"\\a\\b\\t\\n\\v\\f\\r\"" + +The format of the result depends on the encoding of the string: + + s = 'hello' + s.encoding # => # + s.dump # => "\"hello\"" + s.encode('utf-16').dump # => "\"\\xFE\\xFF\\x00h\\x00e\\x00l\\x00l\\x00o\".dup.force_encoding(\"UTF-16\")" + s.encode('utf-16le').dump # => "\"h\\x00e\\x00l\\x00l\\x00o\\x00\".dup.force_encoding(\"UTF-16LE\")" + + s = 'тест' + s.encoding # => # + s.dump # => "\"\\u0442\\u0435\\u0441\\u0442\"" + s.encode('utf-16').dump # => "\"\\xFE\\xFF\\x04B\\x045\\x04A\\x04B\".dup.force_encoding(\"UTF-16\")" + s.encode('utf-16le').dump # => "\"B\\x045\\x04A\\x04B\\x04\".dup.force_encoding(\"UTF-16LE\")" + + s = 'こんにちは' + s.encoding # => # + s.dump # => "\"\\u3053\\u3093\\u306B\\u3061\\u306F\"" + s.encode('utf-16').dump # => "\"\\xFE\\xFF0S0\\x930k0a0o\".dup.force_encoding(\"UTF-16\")" + s.encode('utf-16le').dump # => "\"S0\\x930k0a0o0\".dup.force_encoding(\"UTF-16LE\")" + +Related: see {Converting to New String}[rdoc-ref:String@Converting+to+New+String]. diff --git a/string.c b/string.c index b1dccce4ef9690..cec197d0828389 100644 --- a/string.c +++ b/string.c @@ -7412,16 +7412,9 @@ rb_str_inspect(VALUE str) /* * call-seq: - * dump -> string + * dump -> new_string * - * Returns a printable version of +self+, enclosed in double-quotes, - * with special characters escaped, and with non-printing characters - * replaced by hexadecimal notation: - * - * "hello \n ''".dump # => "\"hello \\n ''\"" - * "\f\x00\xff\\\"".dump # => "\"\\f\\x00\\xFF\\\\\\\"\"" - * - * Related: String#undump (inverse of String#dump). + * :include: doc/string/dump.rdoc * */ pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy