CSV#header_row?

csv.header_row? → true or false

# File tmp/rubies/ruby-3.3.0/lib/csv.rb, line 2631
def header_row?
  parser.header_row?
end

Returns true if the next row to be read is a header row\; false otherwise.

Without headers:

Example

string = "foo,0\nbar,1\nbaz,2\n"
csv = CSV.new(string)
csv.header_row? # => false

With headers:

Example

string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
csv = CSV.new(string, headers: true)
csv.header_row? # => true
csv.shift # => #<CSV::Row "Name":"foo" "Value":"0">
csv.header_row? # => false

Raises an exception if the source is not opened for reading:

Example

string = "foo,0\nbar,1\nbaz,2\n"
csv = CSV.new(string)
csv.close
# Raises IOError (not opened for reading)
csv.header_row?

See also #header_fields_converter #headers #header_converters #inspect also in 3.2 · 3.1 · 3.0

‹ prev#header_fields_converter next ›#headers