Class: Arrow::ListDataType

Inherits:
Object
  • Object
show all
Defined in:
lib/arrow/list-data-type.rb

Instance Method Summary collapse

Constructor Details

#initialize(field) ⇒ ListDataType #initialize(description) ⇒ ListDataType

Creates a new Arrow::ListDataType.

Overloads:

  • #initialize(field) ⇒ ListDataType

    Examples:

    Create a list data type with Field

    visible_field = Arrow::Field.new("visible", :boolean)
    Arrow::ListDataType.new(visible_field)

    Create a list data type with field description

    Arrow::ListDataType.new(name: "visible", type: :boolean)

    Parameters:

    • field (Arrow::Field, Hash)

      The field of the list data type. You can also specify field description by ‘Hash`.

      See Field.new how to specify field description.

  • #initialize(description) ⇒ ListDataType

    Examples:

    Create a list data type with Field

    visible_field = Arrow::Field.new("visible", :boolean)
    Arrow::ListDataType.new(field: visible_field)

    Create a list data type with field description

    Arrow::ListDataType.new(field: {name: "visible", type: :boolean})

    Parameters:

    • description (Hash)

      The description of the list data type. It must have ‘:field` value.

    Options Hash (description):

    • :field (Arrow::Field, Hash)

      The field of the list data type. You can also specify field description by ‘Hash`.

      See Field.new how to specify field description.



56
57
58
59
60
61
62
63
64
65
66
# File 'lib/arrow/list-data-type.rb', line 56

def initialize(field)
  if field.is_a?(Hash) and field.key?(:field)
    description = field
    field = description[:field]
  end
  if field.is_a?(Hash)
    field_description = field
    field = Field.new(field_description)
  end
  initialize_raw(field)
end