?HAMA

Navigation

Breadcrumbs

Create

Edit File Size: 1.44 KB

/proc/thread-self/root/opt/alt/ruby34/share/gems/gems/csv-3.3.2/doc/csv/options/parsing/headers.rdoc

Text Base64

====== Option +headers+

Specifies a boolean, \Symbol, \Array, or \String to be used
to define column headers.

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

---

Without +headers+:
  str = <<-EOT
  Name,Count
  foo,0
  bar,1
  bax,2
  EOT
  csv = CSV.new(str)
  csv # => #<CSV io_type:StringIO encoding:UTF-8 lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"">
  csv.headers # => nil
  csv.shift # => ["Name", "Count"]

---

If set to +true+ or the \Symbol +:first_row+,
the first row of the data is treated as a row of headers:
  str = <<-EOT
  Name,Count
  foo,0
  bar,1
  bax,2
  EOT
  csv = CSV.new(str, headers: true)
  csv # => #<CSV io_type:StringIO encoding:UTF-8 lineno:2 col_sep:"," row_sep:"\n" quote_char:"\"" headers:["Name", "Count"]>
  csv.headers # => ["Name", "Count"]
  csv.shift # => #<CSV::Row "Name":"bar" "Count":"1">

---

If set to an \Array, the \Array elements are treated as headers:
  str = <<-EOT
  foo,0
  bar,1
  bax,2
  EOT
  csv = CSV.new(str, headers: ['Name', 'Count'])
  csv
  csv.headers # => ["Name", "Count"]
  csv.shift # => #<CSV::Row "Name":"bar" "Count":"1">

---

If set to a \String +str+, method <tt>CSV::parse_line(str, options)</tt> is called
with the current +options+, and the returned \Array is treated as headers:
  str = <<-EOT
  foo,0
  bar,1
  bax,2
  EOT
  csv = CSV.new(str, headers: 'Name,Count')
  csv
  csv.headers # => ["Name", "Count"]
  csv.shift # => #<CSV::Row "Name":"bar" "Count":"1">

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
converters.rdoc	1.46 KB	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
empty_value.rdoc	400 B	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
field_size_limit.rdoc	1.16 KB	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
headers.rdoc	1.44 KB	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
header_converters.rdoc	1.44 KB	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
liberal_parsing.rdoc	1.50 KB	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
nil_value.rdoc	351 B	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
return_headers.rdoc	568 B	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
skip_blanks.rdoc	784 B	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
skip_lines.rdoc	1.06 KB	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
strip.rdoc	363 B	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive
unconverted_fields.rdoc	976 B	lrw-r--r--	2026-04-20 12:16:12	Edit Download recursive recursive

Directory Contents