Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > Timeクラス

class Time

クラス・モジュールの継承リスト: Time < Comparable < Object < Kernel < BasicObject

要約

時刻を表すクラスです。

Time.now は現在の時刻を返します。 File.mtime などが返すファイルのタイムスタンプは Time オブジェクトです。

Time オブジェクトは時刻を起算時からの経過秒数で保持しています。起算時は協定世界時(UTC、もしくはその旧称から GMT とも表記されます) の 1970年1月1日午前0時です。なお、うるう秒を勘定するかどうかはシステムによります。

Time オブジェクトが格納可能な時刻の範囲は環境によって異なっていましたが、 Ruby 1.9.2 からは OS の制限の影響を受けません。

また、Time オブジェクトは協定世界時と地方時のどちらのタイムゾーンを使用するかのフラグを内部に保持しています。タイムゾーンのフラグは Marshal データに保持されます。


p Marshal.load(Marshal.dump(Time.now.gmtime)).zone
# => "UTC"

time ライブラリによって、Time.parse, Time.rfc2822, Time.httpdate, Time.iso8601 等が拡張されます。

Ruby 1.9.2 以降の Time クラスのデザインの詳細は https://staff.aist.go.jp/tanaka-akira/pub/sapporo-rubykaigi-02-akr-2009.pdf や「APIデザインケーススタディ」(https://gihyo.jp/book/2016/978-4-7741-7802-8) の第4章を参照してください。

localtime(3) も参照してください。

C 言語との違いに注意

C 言語の tm 構造体とは異なり、month は 1 月に対して 1 を返し、year は 1998 年に対して 1998 を返します。また、 yday は 1 から数えます。

特異メソッド

定義 説明
at(time) -> Time

time で指定した時刻の Time オブジェクトを返します。

at(time, usec) -> Time

time + (usec/1000000) の時刻を表す Time オブジェクトを返します。浮動小数点の精度では不十分な場合に使用します。

gm(year, mon = 1, day = 1, hour = 0, min = 0, sec = 0, usec = 0) -> Time
utc(year, mon = 1, day = 1, hour = 0, min = 0, sec = 0, usec = 0) -> Time

引数で指定した協定世界時の Time オブジェクトを返します。

gm(sec, min, hour, mday, mon, year, wday, yday, isdst, zone) -> Time
utc(sec, min, hour, mday, mon, year, wday, yday, isdst, zone) -> Time

引数で指定した協定世界時の Time オブジェクトを返します。

local(year, mon = 1, day = 1, hour = 0, min = 0, sec = 0, usec = 0) -> Time
mktime(year, mon = 1, day = 1, hour = 0, min = 0, sec = 0, usec = 0) -> Time

引数で指定した地方時の Time オブジェクトを返します。

local(sec, min, hour, mday, mon, year, wday, yday, isdst, zone) -> Time
mktime(sec, min, hour, mday, mon, year, wday, yday, isdst, zone) -> Time

引数で指定した地方時の Time オブジェクトを返します。

new -> Time
now -> Time

現在時刻の Time オブジェクトを生成して返します。タイムゾーンは地方時となります。

new(year, mon = nil, day = nil, hour = nil, min = nil, sec = nil, zone = nil) -> Time

引数で指定した地方時の Time オブジェクトを返します。

インスタンスメソッド

定義 説明
self + other -> Time

self より other 秒だけ後の時刻を返します。

self - time -> Float

自身と time との時刻の差を Float で返します。単位は秒です。

self - sec -> Time

自身より sec 秒だけ前の時刻を返します。

self <=> other -> -1 | 0 | 1 | nil

self と other の時刻を比較します。self の方が大きい場合は 1 を、等しい場合は 0 を、小さい場合は -1 を返します。比較できない場合は、nil を返します。

asctime -> String
ctime -> String

時刻を asctime(3) の形式の文字列に変換します。ただし、末尾の改行文字 "\n" は含まれません。

mday -> Integer
day -> Integer

日を整数で返します。

isdst -> bool
dst? -> bool

自身が表す日時が夏時間なら true を返します。そうでないなら false を返します。

eql?(other) -> bool

other が Time かそのサブクラスのインスタンスであり自身と時刻が等しい場合に true を返します。そうでない場合に false を返します。

friday? -> bool

self の表す時刻が金曜日である場合に true を返します。そうでない場合に false を返します。

getgm -> Time
getutc -> Time

タイムゾーンを協定世界時に設定した Time オブジェクトを新しく生成して返します。

getlocal -> Time
getlocal(utc_offset) -> Time

タイムゾーンを地方時に設定した Time オブジェクトを新しく生成して返します。

gmt? -> bool
utc? -> bool

self のタイムゾーンが協定世界時に設定されていれば真を返します。

utc_offset -> Integer
gmt_offset -> Integer
gmtoff -> Integer

協定世界時との時差を秒を単位とする数値として返します。

gmtime -> self
utc -> self

タイムゾーンを協定世界時に設定します。

hash -> Integer

self のハッシュ値を返します。

hour -> Integer

時を整数で返します。

localtime -> self
localtime(utc_offset) -> self

タイムゾーンを地方時に設定します。

min -> Integer

分を整数で返します。

mon -> Integer
month -> Integer

月を整数で返します。

monday? -> bool

self の表す時刻が月曜日である場合に true を返します。そうでない場合に false を返します。

nsec -> Integer
tv_nsec -> Integer

時刻のナノ秒の部分を整数で返します。

round(ndigits=0) -> Time

十進小数点数で指定した桁数の精度で丸めをし、その Time オブジェクトを返します。 (デフォルトは0、つまり小数点の所で丸めます)。

saturday? -> bool

self の表す時刻が土曜日である場合に true を返します。そうでない場合に false を返します。

sec -> Integer

秒を整数で返します。

strftime(format) -> String

時刻を format 文字列に従って文字列に変換した結果を返します。

subsec -> Integer | Rational

時刻を表す分数を返します。

succ -> Time

self に 1 秒足した Time オブジェクトを生成して返します。

sunday? -> bool

self の表す時刻が日曜日である場合に true を返します。そうでない場合に false を返します。

thursday? -> bool

self の表す時刻が木曜日である場合に true を返します。そうでない場合に false を返します。

to_a -> Array

時刻を10要素の配列で返します。

to_f -> Float

起算時からの経過秒数を浮動小数点数で返します。1 秒に満たない経過も表現されます。

to_i -> Integer
tv_sec -> Integer

起算時からの経過秒数を整数で返します。

to_r -> Rational

起算時からの経過秒数を有理数で返します。1 秒に満たない経過も表現されます。

to_s -> String

時刻を文字列に変換した結果を返します。以下のようにフォーマット文字列を使って strftime を呼び出すのと同じです。

tuesday? -> bool

self の表す時刻が火曜日である場合に true を返します。そうでない場合に false を返します。

usec -> Integer
tv_usec -> Integer

時刻のマイクロ秒の部分を整数で返します。

wday -> Integer

曜日を0(日曜日)から6(土曜日)の整数で返します。

wednesday? -> bool

self の表す時刻が水曜日である場合に true を返します。そうでない場合に false を返します。

yday -> Integer

1月1日を1とした通算日(1から366まで)を整数で返します。

year -> Integer

年を整数で返します。

zone -> String

タイムゾーンを表す文字列を返します。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined < <= == > >= between? !~ === =~ _dump class clone define_singleton_method display enum_for equal? extend freeze frozen? initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_ary to_hash to_int to_io to_proc to_regexp to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE

追加されるメソッド

定義 説明 ライブラリ
httpdate(date) -> Time

[RFC2616]で定義されているHTTP-dateとしてdateをパースして Timeオブジェクトに変換します。

time
httpdate -> String

[RFC2616] で定義されている HTTP-date の rfc1123-date 形式の文字列を返します。

time
xmlschema(fractional_seconds = 0) -> String
iso8601(fractional_seconds = 0) -> String

XML Schema で定義されている dateTime として表現される形式の文字列を返します。

time
xmlschema(date) -> Time
iso8601(date) -> Time

XML Schema で定義されている dateTime として date をパースして Time オブジェクトに変換します。

time
json_create(hash) -> Time

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

json/add/time
parse(date, now = Time.now) -> Time
parse(date, now = Time.now) {|year| year } -> Time
time
rfc2822 -> String
rfc822 -> String

[RFC2822] で定義されている date-time として表現される形式の文字列を返します。

time
rfc2822(date) -> Time
rfc822(date) -> Time

[RFC2822]で定義されているdate-timeとしてdateをパースして Timeオブジェクトに変換します。この形式は[RFC822]で定義されて[RFC1123]で更新された形式と同じです。

time
strptime(date, format, now=self.now) -> Time
strptime(date, format, now=self.now) {|y| ... } -> Time

文字列を Date._strptime を用いて Time オブジェクトに変換します。

time
to_date -> Date

対応する Date オブジェクトを返します。

date
to_datetime -> DateTime

対応する DateTime オブジェクトを返します。

date
to_json(*args) -> String

自身を JSON 形式の文字列に変換して返します。

json/add/time
to_time -> Time

対応する Time オブジェクトを返します。

date