summaryrefslogtreecommitdiff
path: root/doc/csv/return_headers.rdoc
blob: 45d2e3f3de10e5c3716d39fb2681ec4e37e16102 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
====== 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">