diff options
Diffstat (limited to 'doc/csv/options/common/quote_char.rdoc')
-rw-r--r-- | doc/csv/options/common/quote_char.rdoc | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/csv/options/common/quote_char.rdoc b/doc/csv/options/common/quote_char.rdoc new file mode 100644 index 0000000000..eb2ad9c0c8 --- /dev/null +++ b/doc/csv/options/common/quote_char.rdoc @@ -0,0 +1,32 @@ +====== Option +quote_char+ + +Specifies the character (\String of length 1) used used to quote fields +in both parsing and generating. +This String will be transcoded into the data's \Encoding before use. + +Default value: + CSV::DEFAULT_OPTIONS.fetch(:quote_char) # => "\"" (backslash) + +This is useful for an application that incorrectly uses <tt>'</tt> (single-quote) +to quote fields, instead of the correct <tt>"</tt> (double-quote). + +Using the default: + ary = ['a', 'b', '"c"', 'd'] + str = CSV.generate_line(ary) + str # => "a,b,\"\"\"c\"\"\",d\n" + ary = CSV.parse_line(str) + ary # => ["a", "b", "\"c\"", "d"] + +Using <tt>'</tt> (single-quote): + quote_char = "'" + ary = ['a', 'b', '\'c\'', 'd'] + str = CSV.generate_line(ary, quote_char: quote_char) + str # => "a,b,'''c''',d\n" + ary = CSV.parse_line(str, quote_char: quote_char) + ary # => [["a", "b", "'c'", "d"]] + +--- + +Raises an exception if the \String length is greater than 1: + # Raises ArgumentError (:quote_char has to be nil or a single character String) + CSV.new('', quote_char: 'xx') |