Your IP : 216.73.216.5

Current Path : /opt/alt/ruby34/share/gems/gems/csv-3.3.2/doc/csv/options/parsing/
Upload File :
Current File : //opt/alt/ruby34/share/gems/gems/csv-3.3.2/doc/csv/options/parsing/return_headers.rdoc

====== Option +return_headers+

Specifies the boolean that determines whether method #shift
returns or ignores the header row.

Default value:
  CSV::DEFAULT_OPTIONS.fetch(:return_headers) # => false

Examples:
  str = <<-EOT
  Name,Count
  foo,0
  bar,1
  bax,2
  EOT
  # Without return_headers first row is str.
  csv = CSV.new(str, headers: true)
  csv.shift # => #<CSV::Row "Name":"foo" "Count":"0">
  # With return_headers first row is headers.
  csv = CSV.new(str, headers: true, return_headers: true)
  csv.shift # => #<CSV::Row "Name":"Name" "Count":"Count">