Class: Time
Overview
Time
is an abstraction of dates and times. Time is stored internally as the number of seconds and microseconds since the epoch, January 1, 1970 00:00 UTC. On some operating systems, this offset is allowed to be negative. Also see the library modules Date
and ParseDate
. The Time
class treats GMT (Greenwich Mean Time) and UTC (Coordinated Universal Time)[Yes, UTC really does stand for Coordinated Universal Time. There was a committee involved.] as equivalent. GMT is the older way of referring to these baseline times but persists in the names of calls on Posix systems.
All times are stored with some number of microseconds. Be aware of this fact when comparing times with each other—times that are apparently equal when displayed may be different when compared.
Class Method Summary collapse
-
._load(string) ⇒ Time
Unmarshal a dumped
Time
object. -
.at ⇒ Object
Creates a new time object with the value given by aTime, or the given number of seconds (and optional microseconds) from epoch.
-
.gm ⇒ Object
Time.gm( year [, month, day, hour, min, sec, usec] ) => time Time.gm( sec, min, hour, day, month, year, wday, yday, isdst, tz ) => time.
-
.local ⇒ Object
Time.mktime( year, month, day, hour, min, sec, usec ) => time.
-
.mktime ⇒ Object
Time.mktime( year, month, day, hour, min, sec, usec ) => time.
-
.new(args, ...) ⇒ Object
Calls
allocate
to create a new object of class’s class, then invokes that object’sinitialize
method, passing it args. -
.times ⇒ Object
Deprecated in favor of
Process::times
. -
.utc ⇒ Object
Time.gm( year [, month, day, hour, min, sec, usec] ) => time Time.gm( sec, min, hour, day, month, year, wday, yday, isdst, tz ) => time.
Instance Method Summary collapse
-
#+(numeric) ⇒ Time
Addition—Adds some number of seconds (possibly fractional) to time and returns that value as a new time.
-
#- ⇒ Object
Difference—Returns a new time that represents the difference between two times, or subtracts the given number of seconds in numeric from time.
-
#<=> ⇒ Object
Comparison—Compares time with other_time or with numeric, which is the number of seconds (possibly fractional) since epoch.
-
#_dump ⇒ String
Dump time for marshaling.
-
#asctime ⇒ Object
Returns a canonical string representation of time.
-
#ctime ⇒ Object
Returns a canonical string representation of time.
-
#day ⇒ Object
Returns the day of the month (1..n) for time.
-
#dst? ⇒ Object
Returns
true
if time occurs during Daylight Saving Time in its time zone. -
#eql?(other_time) ⇒ Boolean
Return
true
if time and other_time are bothTime
objects with the same seconds and fractional seconds. -
#getgm ⇒ Object
Returns a new
new_time
object representing time in UTC. -
#getlocal ⇒ Time
Returns a new
new_time
object representing time in local time (using the local time zone in effect for this process). -
#getutc ⇒ Object
Returns a new
new_time
object representing time in UTC. -
#gmt? ⇒ Object
Returns
true
if time represents a time in UTC (GMT). -
#gmt_offset ⇒ Object
Returns the offset in seconds between the timezone of time and UTC.
-
#gmtime ⇒ Object
Converts time to UTC (GMT), modifying the receiver.
-
#gmtoff ⇒ Object
Returns the offset in seconds between the timezone of time and UTC.
-
#hash ⇒ Fixnum
Return a hash code for this time object.
-
#hour ⇒ Fixnum
Returns the hour of the day (0..23) for time.
-
#initialize ⇒ Object
constructor
Synonym for
Time.new
. -
#initialize_copy ⇒ Object
:nodoc:.
-
#inspect ⇒ Object
Returns a string representing time.
-
#isdst ⇒ Object
Returns
true
if time occurs during Daylight Saving Time in its time zone. -
#localtime ⇒ Time
Converts time to local time (using the local time zone in effect for this process) modifying the receiver.
-
#marshal_dump ⇒ Object
undocumented.
-
#marshal_load ⇒ Object
undocumented.
-
#mday ⇒ Object
Returns the day of the month (1..n) for time.
-
#min ⇒ Fixnum
Returns the minute of the hour (0..59) for time.
-
#mon ⇒ Object
Returns the month of the year (1..12) for time.
-
#month ⇒ Object
Returns the month of the year (1..12) for time.
-
#sec ⇒ Fixnum
Returns the second of the minute (0..60)[Yes, seconds really can range from zero to 60. This allows the system to inject leap seconds every now and then to correct for the fact that years are not really a convenient number of hours long.] for time.
-
#strftime(string) ⇒ String
Formats time according to the directives in the given format string.
-
#succ ⇒ Time
Return a new time object, one second later than
time
. -
#to_a ⇒ Array
Returns a ten-element array of values for time: sec, min, hour, day, month, year, wday, yday, isdst, zone ].
-
#to_f ⇒ Float
Returns the value of time as a floating point number of seconds since epoch.
-
#to_i ⇒ Object
Returns the value of time as an integer number of seconds since epoch.
-
#to_s ⇒ Object
Returns a string representing time.
-
#tv_sec ⇒ Object
Returns the value of time as an integer number of seconds since epoch.
-
#tv_usec ⇒ Object
Returns just the number of microseconds for time.
-
#usec ⇒ Object
Returns just the number of microseconds for time.
-
#utc ⇒ Object
Converts time to UTC (GMT), modifying the receiver.
-
#utc? ⇒ Object
Returns
true
if time represents a time in UTC (GMT). -
#utc_offset ⇒ Object
Returns the offset in seconds between the timezone of time and UTC.
-
#wday ⇒ Fixnum
Returns an integer representing the day of the week, 0..6, with Sunday == 0.
-
#yday ⇒ Fixnum
Returns an integer representing the day of the year, 1..366.
-
#year ⇒ Fixnum
Returns the year for time (including the century).
-
#zone ⇒ String
Returns the name of the time zone used for time.
Methods included from Comparable
#<, #<=, #==, #>, #>=, #between?
Constructor Details
#initialize ⇒ Object
Synonym for Time.new
. Returns a Time
object initialized tot he current system time.
call-seq:
Time.new -> time
Returns a Time
object initialized to the current system time. Note: The object created will be created using the resolution available on your system clock, and so may include fractional seconds.
a = Time.new #=> Wed Apr 09 08:56:03 CDT 2003
b = Time.new #=> Wed Apr 09 08:56:03 CDT 2003
a == b #=> false
"%.6f" % a.to_f #=> "1049896563.230740"
"%.6f" % b.to_f #=> "1049896563.231466"
92 93 94 |
# File 'time.c', line 92 static VALUE time_init(time) VALUE time; |
Class Method Details
._load(string) ⇒ Time
Unmarshal a dumped Time
object.
2028 2029 2030 |
# File 'time.c', line 2028 static VALUE time_load(klass, str) VALUE klass, str; |
.at(aTime) ⇒ Time .at(seconds[, microseconds]) ⇒ Time
Creates a new time object with the value given by aTime, or the given number of seconds (and optional microseconds) from epoch. A non-portable feature allows the offset to be negative on some systems.
Time.at(0) #=> Wed Dec 31 18:00:00 CST 1969
Time.at(946702800) #=> Fri Dec 31 23:00:00 CST 1999
Time.at(-284061600) #=> Sat Dec 31 00:00:00 CST 1960
254 255 256 |
# File 'time.c', line 254 static VALUE time_s_at(argc, argv, klass) int argc; |
.utc(year[, month, day, hour, min, sec, usec]) ⇒ Time .utc(sec, min, hour, day, month, year, wday, yday, isdst, tz) ⇒ Object
Time.gm( year [, month, day, hour, min, sec, usec] ) => time
Time.gm( sec, min, hour, day, month, year, wday, yday, isdst, tz
) => time
Creates a time based on given values, interpreted as UTC (GMT). The year must be specified. Other values default to the minimum value for that field (and may be nil
or omitted). Months may be specified by numbers from 1 to 12, or by the three-letter English month names. Hours are specified on a 24-hour clock (0..23). Raises an ArgumentError
if any values are out of range. Will also accept ten arguments in the order output by Time#to_a
.
Time.utc(2000,"jan",1,20,15,1) #=> Sat Jan 01 20:15:01 UTC 2000
Time.gm(2000,"jan",1,20,15,1) #=> Sat Jan 01 20:15:01 UTC 2000
837 838 839 |
# File 'time.c', line 837 static VALUE time_s_mkutc(argc, argv, klass) int argc; |
.local(year[, month, day, hour, min, sec, usec]) ⇒ Time .local(sec, min, hour, day, month, year, wday, yday, isdst) ⇒ Object
Time.mktime( year, month, day, hour, min, sec, usec ) => time
Same as Time::gm
, but interprets the values in the local time zone.
Time.local(2000,"jan",1,20,15,1) #=> Sat Jan 01 20:15:01 CST 2000
859 860 861 |
# File 'time.c', line 859 static VALUE time_s_mktime(argc, argv, klass) int argc; |
.local(year[, month, day, hour, min, sec, usec]) ⇒ Time .local(sec, min, hour, day, month, year, wday, yday, isdst) ⇒ Object
859 860 861 |
# File 'time.c', line 859 static VALUE time_s_mktime(argc, argv, klass) int argc; |
.new(args, ...) ⇒ Object
Calls allocate
to create a new object of class’s class, then invokes that object’s initialize
method, passing it args. This is the method that ends up getting called whenever an object is constructed using .new.
1585 1586 1587 |
# File 'object.c', line 1585 VALUE rb_class_new_instance(argc, argv, klass) int argc; |
.times ⇒ Object
Deprecated in favor of Process::times
1888 1889 1890 |
# File 'time.c', line 1888 static VALUE time_s_times(obj) VALUE obj; |
.utc(year[, month, day, hour, min, sec, usec]) ⇒ Time .utc(sec, min, hour, day, month, year, wday, yday, isdst, tz) ⇒ Object
Time.gm( year [, month, day, hour, min, sec, usec] ) => time
Time.gm( sec, min, hour, day, month, year, wday, yday, isdst, tz
) => time
Creates a time based on given values, interpreted as UTC (GMT). The year must be specified. Other values default to the minimum value for that field (and may be nil
or omitted). Months may be specified by numbers from 1 to 12, or by the three-letter English month names. Hours are specified on a 24-hour clock (0..23). Raises an ArgumentError
if any values are out of range. Will also accept ten arguments in the order output by Time#to_a
.
Time.utc(2000,"jan",1,20,15,1) #=> Sat Jan 01 20:15:01 UTC 2000
Time.gm(2000,"jan",1,20,15,1) #=> Sat Jan 01 20:15:01 UTC 2000
837 838 839 |
# File 'time.c', line 837 static VALUE time_s_mkutc(argc, argv, klass) int argc; |
Instance Method Details
#+(numeric) ⇒ Time
1339 1340 1341 |
# File 'time.c', line 1339 static VALUE time_plus(time1, time2) VALUE time1, time2; |
#-(other_time) ⇒ Float #-(numeric) ⇒ Time
Difference—Returns a new time that represents the difference between two times, or subtracts the given number of seconds in numeric from time.
t = Time.now #=> Wed Apr 09 08:56:03 CDT 2003
t2 = t + 2592000 #=> Fri May 09 08:56:03 CDT 2003
t2 - t #=> 2592000.0
t2 - 2592000 #=> Wed Apr 09 08:56:03 CDT 2003
1367 1368 1369 |
# File 'time.c', line 1367 static VALUE time_minus(time1, time2) VALUE time1, time2; |
#<=>(other_time) ⇒ -1, ... #<=>(numeric) ⇒ -1, ...
951 952 953 |
# File 'time.c', line 951 static VALUE time_cmp(time1, time2) VALUE time1, time2; |
#_dump ⇒ String
Dump time for marshaling.
1947 1948 1949 |
# File 'time.c', line 1947 static VALUE time_dump(argc, argv, time) int argc; |
#asctime ⇒ String #ctime ⇒ String
1219 1220 1221 |
# File 'time.c', line 1219 static VALUE time_asctime(time) VALUE time; |
#asctime ⇒ String #ctime ⇒ String
1219 1220 1221 |
# File 'time.c', line 1219 static VALUE time_asctime(time) VALUE time; |
#day ⇒ Fixnum #mday ⇒ Fixnum
1489 1490 1491 |
# File 'time.c', line 1489 static VALUE time_mday(time) VALUE time; |
#isdst ⇒ Boolean #dst? ⇒ Boolean
1611 1612 1613 |
# File 'time.c', line 1611 static VALUE time_isdst(time) VALUE time; |
#eql?(other_time) ⇒ Boolean
Return true
if time and other_time are both Time
objects with the same seconds and fractional seconds.
981 982 983 |
# File 'time.c', line 981 static VALUE time_eql(time1, time2) VALUE time1, time2; |
#getgm ⇒ Time #getutc ⇒ Time
1193 1194 1195 |
# File 'time.c', line 1193 static VALUE time_getgmtime(time) VALUE time; |
#getlocal ⇒ Time
1171 1172 1173 |
# File 'time.c', line 1171 static VALUE time_getlocaltime(time) VALUE time; |
#getgm ⇒ Time #getutc ⇒ Time
1193 1194 1195 |
# File 'time.c', line 1193 static VALUE time_getgmtime(time) VALUE time; |
#utc? ⇒ Boolean #gmt? ⇒ Boolean
Returns true
if time represents a time in UTC (GMT).
t = Time.now #=> Wed Apr 09 08:56:04 CDT 2003
t.utc? #=> false
t = Time.gm(2000,"jan",1,20,15,1) #=> Sat Jan 01 20:15:01 UTC 2000
t.utc? #=> true
t = Time.now #=> Wed Apr 09 08:56:03 CDT 2003
t.gmt? #=> false
t = Time.gm(2000,1,1,20,15,1) #=> Sat Jan 01 20:15:01 UTC 2000
t.gmt? #=> true
1016 1017 1018 |
# File 'time.c', line 1016 static VALUE time_utc_p(time) VALUE time; |
#gmt_offset ⇒ Fixnum #gmtoff ⇒ Fixnum #utc_offset ⇒ Fixnum
1680 1681 1682 |
# File 'time.c', line 1680 static VALUE time_utc_offset(time) VALUE time; |
#gmtime ⇒ Time #utc ⇒ Time
1131 1132 1133 |
# File 'time.c', line 1131 static VALUE time_gmtime(time) VALUE time; |
#gmt_offset ⇒ Fixnum #gmtoff ⇒ Fixnum #utc_offset ⇒ Fixnum
1680 1681 1682 |
# File 'time.c', line 1680 static VALUE time_utc_offset(time) VALUE time; |
#hash ⇒ Fixnum
Return a hash code for this time object.
1034 1035 1036 |
# File 'time.c', line 1034 static VALUE time_hash(time) VALUE time; |
#initialize_copy ⇒ Object
:nodoc:
1047 1048 1049 |
# File 'time.c', line 1047 static VALUE time_init_copy(copy, time) VALUE copy, time; |
#inspect ⇒ String #to_s ⇒ String
1249 1250 1251 |
# File 'time.c', line 1249 static VALUE time_to_s(time) VALUE time; |
#isdst ⇒ Boolean #dst? ⇒ Boolean
1611 1612 1613 |
# File 'time.c', line 1611 static VALUE time_isdst(time) VALUE time; |
#localtime ⇒ Time
1087 1088 1089 |
# File 'time.c', line 1087 static VALUE time_localtime(time) VALUE time; |
#marshal_dump ⇒ Object
undocumented
1900 1901 1902 |
# File 'time.c', line 1900 static VALUE time_mdump(time) VALUE time; |
#marshal_load ⇒ Object
undocumented
1969 1970 1971 |
# File 'time.c', line 1969 static VALUE time_mload(time, str) VALUE time, str; |
#day ⇒ Fixnum #mday ⇒ Fixnum
1489 1490 1491 |
# File 'time.c', line 1489 static VALUE time_mday(time) VALUE time; |
#mon ⇒ Fixnum #month ⇒ Fixnum
1514 1515 1516 |
# File 'time.c', line 1514 static VALUE time_mon(time) VALUE time; |
#mon ⇒ Fixnum #month ⇒ Fixnum
1514 1515 1516 |
# File 'time.c', line 1514 static VALUE time_mon(time) VALUE time; |
#sec ⇒ Fixnum
Returns the second of the minute (0..60)[Yes, seconds really can range from zero to 60. This allows the system to inject leap seconds every now and then to correct for the fact that years are not really a convenient number of hours long.] for time.
t = Time.now #=> Wed Apr 09 08:56:04 CDT 2003
t.sec #=> 4
1418 1419 1420 |
# File 'time.c', line 1418 static VALUE time_sec(time) VALUE time; |
#strftime(string) ⇒ String
Formats time according to the directives in the given format string. Any text not listed as a directive will be passed through to the output string.
Format meaning:
%a - The abbreviated weekday name (``Sun'')
%A - The full weekday name (``Sunday'')
%b - The abbreviated month name (``Jan'')
%B - The full month name (``January'')
%c - The preferred local date and time representation
%d - Day of the month (01..31)
%H - Hour of the day, 24-hour clock (00..23)
%I - Hour of the day, 12-hour clock (01..12)
%j - Day of the year (001..366)
%m - Month of the year (01..12)
%M - Minute of the hour (00..59)
%p - Meridian indicator (``AM'' or ``PM'')
%S - Second of the minute (00..60)
%U - Week number of the current year,
starting with the first Sunday as the first
day of the first week (00..53)
%W - Week number of the current year,
starting with the first Monday as the first
day of the first week (00..53)
%w - Day of the week (Sunday is 0, 0..6)
%x - Preferred representation for the date alone, no time
%X - Preferred representation for the time alone, no date
%y - Year without a century (00..99)
%Y - Year with century
%Z - Time zone name
%% - Literal ``%'' character
t = Time.now
t.strftime("Printed on %m/%d/%Y") #=> "Printed on 04/09/2003"
t.strftime("at %I:%M%p") #=> "at 08:56AM"
1834 1835 1836 |
# File 'time.c', line 1834 static VALUE time_strftime(time, format) VALUE time, format; |
#succ ⇒ Time
Return a new time object, one second later than time
.
1395 1396 1397 |
# File 'time.c', line 1395 static VALUE time_succ(time) VALUE time; |
#to_a ⇒ Array
Returns a ten-element array of values for time: sec, min, hour, day, month, year, wday, yday, isdst, zone ]. See the individual methods for an explanation of the valid ranges of each value. The ten elements can be passed directly to Time::utc
or Time::local
to create a new Time
.
now = Time.now #=> Wed Apr 09 08:56:04 CDT 2003
t = now.to_a #=> [4, 56, 8, 9, 4, 2003, 3, 99, true, "CDT"]
1737 1738 1739 |
# File 'time.c', line 1737 static VALUE time_to_a(time) VALUE time; |
#to_i ⇒ Integer #tv_sec ⇒ Integer
881 882 883 |
# File 'time.c', line 881 static VALUE time_to_i(time) VALUE time; |
#inspect ⇒ String #to_s ⇒ String
1249 1250 1251 |
# File 'time.c', line 1249 static VALUE time_to_s(time) VALUE time; |
#to_i ⇒ Integer #tv_sec ⇒ Integer
881 882 883 |
# File 'time.c', line 881 static VALUE time_to_i(time) VALUE time; |
#usec ⇒ Integer #tv_usec ⇒ Integer
925 926 927 |
# File 'time.c', line 925 static VALUE time_usec(time) VALUE time; |
#usec ⇒ Integer #tv_usec ⇒ Integer
925 926 927 |
# File 'time.c', line 925 static VALUE time_usec(time) VALUE time; |
#gmtime ⇒ Time #utc ⇒ Time
1131 1132 1133 |
# File 'time.c', line 1131 static VALUE time_gmtime(time) VALUE time; |
#utc? ⇒ Boolean #gmt? ⇒ Boolean
Returns true
if time represents a time in UTC (GMT).
t = Time.now #=> Wed Apr 09 08:56:04 CDT 2003
t.utc? #=> false
t = Time.gm(2000,"jan",1,20,15,1) #=> Sat Jan 01 20:15:01 UTC 2000
t.utc? #=> true
t = Time.now #=> Wed Apr 09 08:56:03 CDT 2003
t.gmt? #=> false
t = Time.gm(2000,1,1,20,15,1) #=> Sat Jan 01 20:15:01 UTC 2000
t.gmt? #=> true
1016 1017 1018 |
# File 'time.c', line 1016 static VALUE time_utc_p(time) VALUE time; |
#gmt_offset ⇒ Fixnum #gmtoff ⇒ Fixnum #utc_offset ⇒ Fixnum
1680 1681 1682 |
# File 'time.c', line 1680 static VALUE time_utc_offset(time) VALUE time; |