Sha256: 8815a6b164c6a3ffe0465e0409c941879722a17adb5b932157500e3b4d8306fa

Contents?: true

Size: 1.06 KB

Versions: 24

Compression:

Stored size: 1.06 KB

Contents

====== Option +skip_lines+

Specifies an object to use in identifying comment lines in the input that are to be ignored:
* If a \Regexp, ignores lines that match it.
* If a \String, converts it to a \Regexp, ignores lines that match it.
* If +nil+, no lines are considered to be comments.

Default value:
  CSV::DEFAULT_OPTIONS.fetch(:skip_lines) # => nil

For examples in this section:
  str = <<-EOT
  # Comment
  foo,0
  bar,1
  baz,2
  # Another comment
  EOT
  str # => "# Comment\nfoo,0\nbar,1\nbaz,2\n# Another comment\n"

Using the default, +nil+:
  ary = CSV.parse(str)
  ary # => [["# Comment"], ["foo", "0"], ["bar", "1"], ["baz", "2"], ["# Another comment"]]

Using a \Regexp:
  ary = CSV.parse(str, skip_lines: /^#/)
  ary # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]

Using a \String:
  ary = CSV.parse(str, skip_lines: '#')
  ary # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]

---

Raises an exception if given an object that is not a \Regexp, a \String, or +nil+:
  # Raises ArgumentError (:skip_lines has to respond to #match: 0)
  CSV.parse(str, skip_lines: 0)

Version data entries

24 entries across 23 versions & 5 rubygems

Version Path
trusty-cms-7.0.9.1 vendor/bundle/ruby/3.1.0/gems/csv-3.3.0/doc/csv/options/parsing/skip_lines.rdoc
trusty-cms-7.0.9.1 vendor/bundle/ruby/3.3.0/gems/csv-3.3.0/doc/csv/options/parsing/skip_lines.rdoc
csv-3.3.2 doc/csv/options/parsing/skip_lines.rdoc
csv-3.3.1 doc/csv/options/parsing/skip_lines.rdoc
fluent-plugin-nuopenlineage-light-0.1.0 vendor/bundle/ruby/3.3.0/gems/csv-3.3.0/doc/csv/options/parsing/skip_lines.rdoc
fluent-plugin-openlineage-light-0.1.4 vendor/bundle/ruby/3.3.0/gems/csv-3.3.0/doc/csv/options/parsing/skip_lines.rdoc
fluent-plugin-openlineage-light-0.1.3 vendor/bundle/ruby/3.3.0/gems/csv-3.3.0/doc/csv/options/parsing/skip_lines.rdoc
fluent-plugin-openlineage-0.1.0 vendor/bundle/ruby/3.3.0/gems/csv-3.3.0/doc/csv/options/parsing/skip_lines.rdoc
csv-3.3.0 doc/csv/options/parsing/skip_lines.rdoc
csv-3.2.9 doc/csv/options/parsing/skip_lines.rdoc
csv-3.2.8 doc/csv/options/parsing/skip_lines.rdoc
csv-3.2.7 doc/csv/options/parsing/skip_lines.rdoc
csv-3.2.6 doc/csv/options/parsing/skip_lines.rdoc
csv-3.2.5 doc/csv/options/parsing/skip_lines.rdoc
csv-3.2.4 doc/csv/options/parsing/skip_lines.rdoc
csv-3.2.3 doc/csv/options/parsing/skip_lines.rdoc
csv-3.2.2 doc/csv/options/parsing/skip_lines.rdoc
csv-3.2.1 doc/csv/options/parsing/skip_lines.rdoc
csv-3.2.0 doc/csv/options/parsing/skip_lines.rdoc
csv-3.1.9 doc/csv/options/parsing/skip_lines.rdoc