method

generate

v2_5_5 - Show latest stable - 0 notes - Class: CSV

generate(str=nil, **options) public

This method wraps a String you provide, or an empty default String, in a CSV object which is passed to the provided block. You can use the block to append CSV rows to the String and when the block exits, the final String will be returned.

Note that a passed String is modified by this method. Call dup() before passing if you need a new String.

The options parameter can be anything CSV::new() understands. This method understands an additional :encoding parameter when not passed a String to set the base Encoding for the output. CSV needs this hint if you plan to output non-ASCII compatible data.

Show source

# File lib/csv.rb, line 1163
  def self.generate(str=nil, **options)
    # add a default empty String, if none was given
    if str
      io = StringIO.new(str)
      io.seek(0, IO::SEEK_END)
    else
      encoding = options[:encoding]
      str      = String.new
      str.force_encoding(encoding) if encoding
    end
    csv = new(str, options) # wrap
    yield csv         # yield for appending
    csv.string        # return final String
  end

generate

Related methods