summaryrefslogtreecommitdiffstats
path: root/src/arrow/ruby/red-arrow/lib/arrow/time64-data-type.rb
blob: 13795aa83da7469b9f50b5aadaf65bacdb61d772 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

module Arrow
  class Time64DataType
    alias_method :initialize_raw, :initialize
    private :initialize_raw

    # Creates a new {Arrow::Time64DataType}.
    #
    # @overload initialize(unit)
    #
    #   @param unit [Arrow::TimeUnit, Symbol] The unit of the
    #     time64 data type.
    #
    #     The unit must be microsecond or nanosecond.
    #
    #   @example Create a time64 data type with Arrow::TimeUnit
    #     Arrow::Time64DataType.new(Arrow::TimeUnit::NANO)
    #
    #   @example Create a time64 data type with Symbol
    #     Arrow::Time64DataType.new(:nano)
    #
    # @overload initialize(description)
    #
    #   @param description [Hash] The description of the time64 data
    #     type. It must have `:unit` value.
    #
    #   @option description [Arrow::TimeUnit, Symbol] :unit The unit of
    #     the time64 data type.
    #
    #     The unit must be microsecond or nanosecond.
    #
    #   @example Create a time64 data type with Arrow::TimeUnit
    #     Arrow::Time64DataType.new(unit: Arrow::TimeUnit::NANO)
    #
    #   @example Create a time64 data type with Symbol
    #     Arrow::Time64DataType.new(unit: :nano)
    def initialize(unit)
      if unit.is_a?(Hash)
        description = unit
        unit = description[:unit]
      end
      initialize_raw(unit)
    end
  end
end