Class: CSV::FieldInfo

Inherits:
Struct
  • Object
show all
Defined in:
lib/csv.rb

Overview

A FieldInfo Struct contains details about a field’s position in the data source it was read from. CSV will pass this Struct to some blocks that make decisions based on field structure. See CSV.convert_fields() for an example.

index

The zero-based index of the field in its row.

line

The line of the data source this row is from.

header

The header for the column, when available.

quoted?

True or false, whether the original value is quoted or not.

Instance Attribute Summary collapse

Instance Attribute Details

#header ⇒ Object

Returns the value of attribute header

Returns:

  • (Object) —

    the current value of header



869
870
871
 
# File 'lib/csv.rb', line 869

def header
  @header
end

#index ⇒ Object

Returns the value of attribute index

Returns:

  • (Object) —

    the current value of index



869
870
871
 
# File 'lib/csv.rb', line 869

def index
  @index
end

#line ⇒ Object

Returns the value of attribute line

Returns:

  • (Object) —

    the current value of line



869
870
871
 
# File 'lib/csv.rb', line 869

def line
  @line
end

#quoted? ⇒ Object

Returns the value of attribute quoted?

Returns:

  • (Object) —

    the current value of quoted?



869
870
871
 
# File 'lib/csv.rb', line 869

def quoted?
  @quoted?
end