File: return_headers.rdoc

package info (click to toggle)
ruby-csv 3.3.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 472 kB
  • sloc: ruby: 2,483; makefile: 3
file content (22 lines) | stat: -rw-r--r-- 568 bytes parent folder | download | duplicates (8)
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">