Class | FasterCSV::Row |
In: |
lib/faster_csv.rb
|
Parent: | Object |
A FasterCSV::Row is part Array and part Hash. It retains an order for the fields and allows duplicates just as an Array would, but also allows you to access fields by name just as you could if they were in a Hash.
All rows returned by FasterCSV will be constructed from this class, if header row processing is activated.
row | [R] | Internal data format used to compare equality. |
Construct a new FasterCSV::Row from headers and fields, which are expected to be Arrays. If one Array is shorter than the other, it will be padded with nil objects.
The optional header_row parameter can be set to true to indicate, via FasterCSV::Row.header_row?() and FasterCSV::Row.field_row?(), that this is a header row. Otherwise, the row is assumes to be a field row.
A FasterCSV::Row object supports the following Array methods through delegation:
If a two-element Array is provided, it is assumed to be a header and field and the pair is appended. A Hash works the same way with the key being the header and the value being the field. Anything else is assumed to be a lone field which is appended with a nil header.
This method returns the row for chaining.
Looks up the field by the semantics described in FasterCSV::Row.field() and assigns the value.
Assigning past the end of the row with an index will set all pairs between to [nil, nil]. Assigning to an unused header appends the new pair.
Used to remove a pair from the row by header or index. The pair is located as described in FasterCSV::Row.field(). The deleted pair is returned, or nil if a pair could not be found.
This method accepts any number of arguments which can be headers, indices, Ranges of either, or two-element Arrays containing a header and offset. Each argument will be replaced with a field lookup as described in FasterCSV::Row.field().
If called with no arguments, all fields are returned.
This method will return the index of a field with the provided header. The offset can be used to locate duplicate header names, as described in FasterCSV::Row.field().
A shortcut for appending multiple fields. Equivalent to:
args.each { |arg| faster_csv_row << arg }
This method returns the row for chaining.
Returns the row as a CSV String. Headers are not used. Equivalent to:
faster_csv_row.fields.to_csv( options )