Class: Time (Ruby 3.0.0) (original) (raw)

Time is an abstraction of dates and times. Time is stored internally as the number of seconds with subsecond since the Epoch, 1970-01-01 00:00:00 UTC.

The Time class treats GMT (Greenwich Mean Time) and UTC (Coordinated Universal Time) 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 may have subsecond. Be aware of this fact when comparing times with each other – times that are apparently equal when displayed may be different when compared. (Since Ruby 2.7.0, #inspect shows subsecond but #to_s still doesn't show subsecond.)

Since Ruby 1.9.2, Time implementation uses a signed 63 bit integer, Bignum or Rational. The integer is a number of nanoseconds since the Epoch which can represent 1823-11-12 to 2116-02-20. When Bignum or Rational is used (before 1823, after 2116, under nanosecond), Time works slower as when integer is used.

Examples¶ ↑

All of these examples were done using the EST timezone which is GMT-5.

Creating a new Time instance¶ ↑

You can create a new instance of Time with ::new. This will use the current system time. ::now is an alias for this. You can also pass parts of the time to ::new such as year, month, minute, etc. When you want to construct a time this way you must pass at least a year. If you pass the year with nothing else time will default to January 1 of that year at 00:00:00 with the current system timezone. Here are some examples:

Time.new(2002)
Time.new(2002, 10)
Time.new(2002, 10, 31)

You can pass a UTC offset:

Time.new(2002, 10, 31, 2, 2, 2, "+02:00")

Or a timezone object:

tz = timezone("Europe/Athens") Time.new(2002, 10, 31, 2, 2, 2, tz)

You can also use ::local and ::utc to infer local and UTC timezones instead of using the current system setting.

You can also create a new time using ::at which takes the number of seconds (with subsecond) since the Unix Epoch.

Time.at(628232400)

Working with an instance of Time ¶ ↑

Once you have an instance of Time there is a multitude of things you can do with it. Below are some examples. For all of the following examples, we will work on the assumption that you have done the following:

t = Time.new(1993, 02, 24, 12, 0, 0, "+09:00")

Was that a monday?

t.monday?

What year was that again?

t.year

Was it daylight savings at the time?

t.dst?

What's the day a year later?

t + (606024*365)

How many seconds was that since the Unix Epoch?

t.to_i

You can also do standard functions like compare two times.

t1 = Time.new(2010) t2 = Time.new(2011)

t1 == t2 t1 == t1 t1 < t2 t1 > t2

Time.new(2010,10,31).between?(t1, t2)

Timezone argument¶ ↑

A timezone argument must have local_to_utc andutc_to_local methods, and may have name,abbr, and dst? methods.

The local_to_utc method should convert a Time-like object from the timezone to UTC, and utc_to_local is the opposite. The result also should be a Time or Time-like object (not necessary to be the same class). The zone of the result is just ignored. Time-like argument to these methods is similar to a Time object in UTC without subsecond; it has attribute readers for the parts, e.g. year, month, and so on, and epoch time readers, to_i. The subsecond attributes are fixed as 0, and utc_offset, zone, isdst, and their aliases are same as aTime object in UTC. Also to_time, #+, and #- methods are defined.

The name method is used for marshaling. If this method is not defined on a timezone object, Time objects using that timezone object can not be dumped by Marshal.

The abbr method is used by '%Z' in strftime.

The dst? method is called with a Time value and should return whether the Time value is in daylight savings time in the zone.

Auto conversion to Timezone¶ ↑

At loading marshaled data, a timezone name will be converted to a timezone object by find_timezone class method, if the method is defined.

Similarly, that class method will be called when a timezone argument does not have the necessary methods mentioned above.

at(time) → time click to toggle source

at(seconds_with_frac) → time

at(seconds, microseconds_with_frac) → time

at(seconds, milliseconds, :millisecond) → time

at(seconds, microseconds, :usec) → time

at(seconds, microseconds, :microsecond) → time

at(seconds, nanoseconds, :nsec) → time

at(seconds, nanoseconds, :nanosecond) → time

at(time, in: tz) → time

at(seconds_with_frac, in: tz) → time

at(seconds, microseconds_with_frac, in: tz) → time

at(seconds, milliseconds, :millisecond, in: tz) → time

at(seconds, microseconds, :usec, in: tz) → time

at(seconds, microseconds, :microsecond, in: tz) → time

at(seconds, nanoseconds, :nsec, in: tz) → time

at(seconds, nanoseconds, :nanosecond, in: tz) → time

Creates a new Time object with the value given bytime, the given number of seconds_with_frac, orseconds and microseconds_with_frac since the Epoch. seconds_with_frac andmicroseconds_with_frac can be an Integer, Float, Rational, or other Numeric.

If in argument is given, the result is in that timezone or UTC offset, or if a numeric argument is given, the result is in local time. Thein argument accepts the same types of arguments astz argument of ::new: string, number of seconds, or a timezone object.

Time.at(0)
Time.at(Time.at(0))
Time.at(946702800)
Time.at(-284061600)
Time.at(946684800.2).usec
Time.at(946684800, 123456.789).nsec
Time.at(946684800, 123456789, :nsec).nsec

Time.at(1582721899, in: "+09:00")
Time.at(1582721899, in: "UTC")
Time.at(1582721899, in: "C")
Time.at(1582721899, in: 32400)

require 'tzinfo' Time.at(1582721899, in: TZInfo::Timezone.get('Europe/Kiev'))

           static VALUE

time_s_at(int argc, VALUE *argv, VALUE klass) { VALUE time, t, unit = Qundef, zone = Qundef, opts; VALUE vals[TMOPT_MAX_]; wideval_t timew;

argc = rb_scan_args(argc, argv, "12:", &time, &t, &unit, &opts);
if (get_tmopt(opts, vals)) {
    zone = vals[0];
}
if (argc >= 2) {
    int scale = argc == 3 ? get_scale(unit) : 1000000;
    time = num_exact(time);
    t = num_exact(t);
    timew = wadd(rb_time_magnify(v2w(time)), wmulquoll(v2w(t), TIME_SCALE, scale));
    t = time_new_timew(klass, timew);
}
else if (IsTimeval(time)) {
    struct time_object *tobj, *tobj2;
    GetTimeval(time, tobj);
    t = time_new_timew(klass, tobj->timew);
    GetTimeval(t, tobj2);
    TZMODE_COPY(tobj2, tobj);
}
else {
    timew = rb_time_magnify(v2w(num_exact(time)));
    t = time_new_timew(klass, timew);
}
if (zone != Qundef) {
    time_zonelocal(t, zone);
}

return t;

}

gm(year) → time click to toggle source

gm(year, month) → time

gm(year, month, day) → time

gm(year, month, day, hour) → time

gm(year, month, day, hour, min) → time

gm(year, month, day, hour, min, sec_with_frac) → time

gm(year, month, day, hour, min, sec, usec_with_frac) → time

gm(sec, min, hour, day, month, year, dummy, dummy, dummy, dummy) → time

Creates a Time object 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 #to_a.

sec_with_frac and usec_with_frac can have a fractional part.

Time.utc(2000,"jan",1,20,15,1)
Time.gm(2000,"jan",1,20,15,1)

           static VALUE

time_s_mkutc(int argc, VALUE *argv, VALUE klass) { struct vtm vtm;

time_arg(argc, argv, &vtm);
return time_gmtime(time_new_timew(klass, timegmw(&vtm)));

}

local(year) → time click to toggle source

local(year, month) → time

local(year, month, day) → time

local(year, month, day, hour) → time

local(year, month, day, hour, min) → time

local(year, month, day, hour, min, sec_with_frac) → time

local(year, month, day, hour, min, sec, usec_with_frac) → time

local(sec, min, hour, day, month, year, dummy, dummy, isdst, dummy) → time

Same as ::utc, but interprets the values in the local time zone.

Time.local(2000,"jan",1,20,15,1)

           static VALUE

time_s_mktime(int argc, VALUE *argv, VALUE klass) { struct vtm vtm;

time_arg(argc, argv, &vtm);
return time_localtime(time_new_timew(klass, timelocalw(&vtm)));

}

mktime(year) → time click to toggle source

mktime(year, month) → time

mktime(year, month, day) → time

mktime(year, month, day, hour) → time

mktime(year, month, day, hour, min) → time

mktime(year, month, day, hour, min, sec_with_frac) → time

mktime(year, month, day, hour, min, sec, usec_with_frac) → time

mktime(sec, min, hour, day, month, year, dummy, dummy, isdst, dummy) → time

Same as ::utc, but interprets the values in the local time zone.

Time.local(2000,"jan",1,20,15,1)

           static VALUE

time_s_mktime(int argc, VALUE *argv, VALUE klass) { struct vtm vtm;

time_arg(argc, argv, &vtm);
return time_localtime(time_new_timew(klass, timelocalw(&vtm)));

}

new → time click to toggle source

new(year, month=nil, day=nil, hour=nil, min=nil, sec=nil, tz=nil) → time

Returns a Time object.

It is initialized to the current system time if no argument is given.

Note: The new object will use the resolution available on your system clock, and may include subsecond.

If one or more arguments are specified, the time is initialized to the specified time.

sec may have subsecond if it is a rational.

tz specifies the timezone. It can be an offset from UTC, given either as a string such as “+09:00” or a single letter “A”..“Z” excluding “J” (so-called military time zone), or as a number of seconds such as 32400. Or it can be a timezone object, see Timezone argument for details.

a = Time.new
b = Time.new
a == b
"%.6f" % a.to_f
"%.6f" % b.to_f

Time.new(2008,6,21, 13,30,0, "+09:00")

t1 = Time.new(2007,11,1,15,25,0, "+09:00") t2 = Time.new(2007,11,1,12, 5,0, "-05:00") t3 = Time.new(2007,11,1,13,25,0, "-05:00") t4 = Time.new(2007,11,1,16,53,0, "-04:00") t5 = Time.new(2007,11,5, 9,24,0, "-05:00") t6 = Time.new(2007,11,5,11,21,0, "-05:00") t7 = Time.new(2007,11,5,13,45,0, "-05:00") t8 = Time.new(2007,11,6,17,10,0, "+09:00") (t2-t1)/3600.0
(t4-t3)/3600.0
(t6-t5)/3600.0
(t8-t7)/3600.0

           static VALUE

time_init(int argc, VALUE *argv, VALUE time) { if (argc == 0) return time_init_0(time); else return time_init_1(argc, argv, time); }

now → time click to toggle source

Creates a new Time object for the current time. This is same as ::new without arguments.

Time.now

           static VALUE

time_s_now(int argc, VALUE *argv, VALUE klass) { VALUE vals[TMOPT_MAX_], opts, t, zone = Qundef; rb_scan_args(argc, argv, ":", &opts); if (get_tmopt(opts, vals)) zone = vals[TMOPT_IN]; t = rb_class_new_instance(0, NULL, klass); if (zone != Qundef) { time_zonelocal(t, zone); } return t; }

utc(year) → time click to toggle source

utc(year, month) → time

utc(year, month, day) → time

utc(year, month, day, hour) → time

utc(year, month, day, hour, min) → time

utc(year, month, day, hour, min, sec_with_frac) → time

utc(year, month, day, hour, min, sec, usec_with_frac) → time

utc(sec, min, hour, day, month, year, dummy, dummy, dummy, dummy) → time

sec_with_frac and usec_with_frac can have a fractional part.

Time.utc(2000,"jan",1,20,15,1)
Time.gm(2000,"jan",1,20,15,1)

           static VALUE

time_s_mkutc(int argc, VALUE *argv, VALUE klass) { struct vtm vtm;

time_arg(argc, argv, &vtm);
return time_gmtime(time_new_timew(klass, timegmw(&vtm)));

}

time + numeric → time click to toggle source

Adds some number of seconds (possibly including subsecond) to _time_and returns that value as a new Time object.

t = Time.now
t + (60 * 60 * 24)

           static VALUE

time_plus(VALUE time1, VALUE time2) { struct time_object *tobj; GetTimeval(time1, tobj);

if (IsTimeval(time2)) {
    rb_raise(rb_eTypeError, "time + time?");
}
return time_add(tobj, time1, time2, 1);

}

time - other_time → float click to toggle source

time - numeric → time

Returns a difference in seconds as a Float between_time_ and other_time, or subtracts the given number of seconds in numeric from time.

t = Time.now
t2 = t + 2592000
t2 - t
t2 - 2592000

           static VALUE

time_minus(VALUE time1, VALUE time2) { struct time_object *tobj;

GetTimeval(time1, tobj);
if (IsTimeval(time2)) {
    struct time_object *tobj2;

    GetTimeval(time2, tobj2);
    return rb_Float(rb_time_unmagnify_to_float(wsub(tobj->timew, tobj2->timew)));
}
return time_add(tobj, time1, time2, -1);

}

time <=> other_time → -1, 0, +1, or nil click to toggle source

Compares time with other_time.

-1, 0, +1 or nil depending on whether time is less than, equal to, or greater than other_time.

nil is returned if the two values are incomparable.

t = Time.now
t2 = t + 2592000
t <=> t2
t2 <=> t

t = Time.now
t2 = t + 0.1
t.nsec
t2.nsec
t <=> t2
t2 <=> t
t <=> t

           static VALUE

time_cmp(VALUE time1, VALUE time2) { struct time_object *tobj1, *tobj2; int n;

GetTimeval(time1, tobj1);
if (IsTimeval(time2)) {
    GetTimeval(time2, tobj2);
    n = wcmp(tobj1->timew, tobj2->timew);
}
else {
    return rb_invcmp(time1, time2);
}
if (n == 0) return INT2FIX(0);
if (n > 0) return INT2FIX(1);
return INT2FIX(-1);

}

asctime → string click to toggle source

Returns a canonical string representation of time.

Time.now.asctime
Time.now.ctime

           static VALUE

time_asctime(VALUE time) { return strftimev("%a %b %e %T %Y", time, rb_usascii_encoding()); }

ceil([ndigits]) → new_time click to toggle source

Ceils subsecond to a given precision in decimal digits (0 digits by default). It returns a new Time object.ndigits should be zero or a positive integer.

t = Time.utc(2010,3,30, 5,43,25.0123456789r) t
t.ceil
t.ceil(0)
t.ceil(1)
t.ceil(2)
t.ceil(3)
t.ceil(4)

t = Time.utc(1999,12,31, 23,59,59) (t + 0.4).ceil
(t + 0.9).ceil
(t + 1.4).ceil
(t + 1.9).ceil

t = Time.utc(1999,12,31, 23,59,59) (t + 0.123456789).ceil(4)

           static VALUE

time_ceil(int argc, VALUE *argv, VALUE time) { VALUE ndigits, v, den; struct time_object *tobj;

if (!rb_check_arity(argc, 0, 1) || NIL_P(ndigits = argv[0]))
    den = INT2FIX(1);
else
    den = ndigits_denominator(ndigits);

GetTimeval(time, tobj);
v = w2v(rb_time_unmagnify(tobj->timew));

v = modv(v, den);
if (!rb_equal(v, INT2FIX(0))) {
    v = subv(den, v);
}
return time_add(tobj, time, v, 1);

}

ctime → string click to toggle source

Returns a canonical string representation of time.

Time.now.asctime
Time.now.ctime

           static VALUE

time_asctime(VALUE time) { return strftimev("%a %b %e %T %Y", time, rb_usascii_encoding()); }

day → integer click to toggle source

Returns the day of the month (1..31) for time.

t = Time.now
t.day
t.mday

           static VALUE

time_mday(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
MAKE_TM(time, tobj);
return INT2FIX(tobj->vtm.mday);

}

dst? → true or false click to toggle source

Returns true if time occurs during Daylight Saving Time in its time zone.

Time.local(2000, 1, 1).zone
Time.local(2000, 1, 1).isdst
Time.local(2000, 1, 1).dst?
Time.local(2000, 7, 1).zone
Time.local(2000, 7, 1).isdst
Time.local(2000, 7, 1).dst?

           static VALUE

time_isdst(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
MAKE_TM(time, tobj);
if (tobj->vtm.isdst == VTM_ISDST_INITVAL) {
    rb_raise(rb_eRuntimeError, "isdst is not set yet");
}
return tobj->vtm.isdst ? Qtrue : Qfalse;

}

eql?(other_time) click to toggle source

Returns true if time and other_time are both Time objects with the same seconds (including subsecond) from the Epoch.

           static VALUE

time_eql(VALUE time1, VALUE time2) { struct time_object *tobj1, *tobj2;

GetTimeval(time1, tobj1);
if (IsTimeval(time2)) {
    GetTimeval(time2, tobj2);
    return rb_equal(w2v(tobj1->timew), w2v(tobj2->timew));
}
return Qfalse;

}

floor([ndigits]) → new_time click to toggle source

Floors subsecond to a given precision in decimal digits (0 digits by default). It returns a new Time object.ndigits should be zero or a positive integer.

t = Time.utc(2010,3,30, 5,43,25.123456789r) t
t.floor
t.floor(0)
t.floor(1)
t.floor(2)
t.floor(3)
t.floor(4)

t = Time.utc(1999,12,31, 23,59,59) (t + 0.4).floor
(t + 0.9).floor
(t + 1.4).floor
(t + 1.9).floor

t = Time.utc(1999,12,31, 23,59,59) (t + 0.123456789).floor(4)

           static VALUE

time_floor(int argc, VALUE *argv, VALUE time) { VALUE ndigits, v, den; struct time_object *tobj;

if (!rb_check_arity(argc, 0, 1) || NIL_P(ndigits = argv[0]))
    den = INT2FIX(1);
else
    den = ndigits_denominator(ndigits);

GetTimeval(time, tobj);
v = w2v(rb_time_unmagnify(tobj->timew));

v = modv(v, den);
return time_add(tobj, time, v, -1);

}

friday? → true or false click to toggle source

Returns true if time represents Friday.

t = Time.local(1987, 12, 18)
t.friday?

           static VALUE

time_friday(VALUE time) { wday_p(5); }

getgm → new_time click to toggle source

Returns a new Time object representing_time_ in UTC.

t = Time.local(2000,1,1,20,15,1)
t.gmt?
y = t.getgm
y.gmt?
t == y

           static VALUE

time_getgmtime(VALUE time) { return time_gmtime(time_dup(time)); }

getlocal → new_time click to toggle source

getlocal(utc_offset) → new_time

getlocal(timezone) → new_time

Returns a new Time object representing_time_ in local time (using the local time zone in effect for this process).

If utc_offset is given, it is used instead of the local time.utc_offset can be given as a human-readable string (eg."+09:00") or as a number of seconds (eg.32400).

t = Time.utc(2000,1,1,20,15,1)
t.utc?

l = t.getlocal
l.utc?
t == l

j = t.getlocal("+09:00")
j.utc?
t == j

k = t.getlocal(96060)
k.utc?
t == k

           static VALUE

time_getlocaltime(int argc, VALUE *argv, VALUE time) { VALUE off;

if (rb_check_arity(argc, 0, 1) && !NIL_P(off = argv[0])) {
    VALUE zone = off;
    if (maybe_tzobj_p(zone)) {
        VALUE t = time_dup(time);
        if (zone_localtime(off, t)) return t;
    }

    if (NIL_P(off = utc_offset_arg(off))) {
        if (NIL_P(zone = find_timezone(time, zone))) invalid_utc_offset();
        time = time_dup(time);
        if (!zone_localtime(zone, time)) invalid_utc_offset();
        return time;
    }
    else if (off == UTC_ZONE) {
        return time_gmtime(time_dup(time));
    }
    validate_utc_offset(off);

    time = time_dup(time);
    time_set_utc_offset(time, off);
    return time_fixoff(time);
}

return time_localtime(time_dup(time));

}

getutc → new_time click to toggle source

Returns a new Time object representing_time_ in UTC.

t = Time.local(2000,1,1,20,15,1)
t.gmt?
y = t.getgm
y.gmt?
t == y

           static VALUE

time_getgmtime(VALUE time) { return time_gmtime(time_dup(time)); }

gmt? → true or false click to toggle source

Returns true if time represents a time in UTC (GMT).

t = Time.now
t.utc?
t = Time.gm(2000,"jan",1,20,15,1)
t.utc?

t = Time.now
t.gmt?
t = Time.gm(2000,1,1,20,15,1)
t.gmt?

           static VALUE

time_utc_p(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
if (TZMODE_UTC_P(tobj)) return Qtrue;
return Qfalse;

}

gmt_offset → integer click to toggle source

Returns the offset in seconds between the timezone of time and UTC.

t = Time.gm(2000,1,1,20,15,1)
t.gmt_offset
l = t.getlocal
l.gmt_offset

           VALUE

rb_time_utc_offset(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);

if (TZMODE_UTC_P(tobj)) {
    return INT2FIX(0);
}
else {
    MAKE_TM(time, tobj);
    return tobj->vtm.utc_offset;
}

}

gmtime → time click to toggle source

Converts time to UTC (GMT), modifying the receiver.

t = Time.now
t.gmt?
t.gmtime
t.gmt?

t = Time.now
t.utc?
t.utc
t.utc?

           static VALUE

time_gmtime(VALUE time) { struct time_object *tobj; struct vtm vtm;

GetTimeval(time, tobj);
if (TZMODE_UTC_P(tobj)) {
    if (tobj->tm_got)
        return time;
}
else {
    time_modify(time);
}

vtm.zone = str_utc;
GMTIMEW(tobj->timew, &vtm);
tobj->vtm = vtm;

tobj->tm_got = 1;
TZMODE_SET_UTC(tobj);
return time;

}

gmtoff → integer click to toggle source

Returns the offset in seconds between the timezone of time and UTC.

t = Time.gm(2000,1,1,20,15,1)
t.gmt_offset
l = t.getlocal
l.gmt_offset

           VALUE

rb_time_utc_offset(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);

if (TZMODE_UTC_P(tobj)) {
    return INT2FIX(0);
}
else {
    MAKE_TM(time, tobj);
    return tobj->vtm.utc_offset;
}

}

hash → integer click to toggle source

Returns a hash code for this Time object.

change case

: use colons for %z

The minimum field width specifies the minimum width.

The modifiers are “E” and “O”. They are ignored.

Format directives:

Date (Year, Month, Day): %Y - Year with century if provided, will pad result at least 4 digits. -0001, 0000, 1995, 2009, 14292, etc. %C - year / 100 (rounded down such as 20 in 2009) %y - year % 100 (00..99)

%m - Month of the year, zero-padded (01..12) %_m blank-padded ( 1..12) %-m no-padded (1..12) %B - The full month name (January'') %^B uppercased (JANUARY'') %b - The abbreviated month name (Jan'') %^b uppercased (JAN'') %h - Equivalent to %b

%d - Day of the month, zero-padded (01..31) %-d no-padded (1..31) %e - Day of the month, blank-padded ( 1..31)

%j - Day of the year (001..366)

Time (Hour, Minute, Second, Subsecond): %H - Hour of the day, 24-hour clock, zero-padded (00..23) %k - Hour of the day, 24-hour clock, blank-padded ( 0..23) %I - Hour of the day, 12-hour clock, zero-padded (01..12) %l - Hour of the day, 12-hour clock, blank-padded ( 1..12) %P - Meridian indicator, lowercase (am'' or pm'') %p - Meridian indicator, uppercase (AM'' or PM'')

%M - Minute of the hour (00..59)

%S - Second of the minute (00..60)

%L - Millisecond of the second (000..999) The digits under millisecond are truncated to not produce 1000. %N - Fractional seconds digits, default is 9 digits (nanosecond) %3N millisecond (3 digits) %6N microsecond (6 digits) %9N nanosecond (9 digits) %12N picosecond (12 digits) %15N femtosecond (15 digits) %18N attosecond (18 digits) %21N zeptosecond (21 digits) %24N yoctosecond (24 digits) The digits under the specified length are truncated to avoid carry up.

Time zone: %z - Time zone as hour and minute offset from UTC (e.g. +0900) %:z - hour and minute offset from UTC with a colon (e.g. +09:00) %::z - hour, minute and second offset from UTC (e.g. +09:00:00) %Z - Abbreviated time zone name or similar information. (OS dependent)

Weekday: %A - The full weekday name (Sunday'') %^A uppercased (SUNDAY'') %a - The abbreviated name (Sun'') %^a uppercased (SUN'') %u - Day of the week (Monday is 1, 1..7) %w - Day of the week (Sunday is 0, 0..6)

ISO 8601 week-based year and week number: The first week of YYYY starts with a Monday and includes YYYY-01-04. The days in the year before the first week are in the last week of the previous year. %G - The week-based year %g - The last 2 digits of the week-based year (00..99) %V - Week number of the week-based year (01..53)

Week number: The first week of YYYY that starts with a Sunday or Monday (according to %U or %W). The days in the year before the first week are in week 0. %U - Week number of the year. The week starts with Sunday. (00..53) %W - Week number of the year. The week starts with Monday. (00..53)

Seconds since the Epoch: %s - Number of seconds since 1970-01-01 00:00:00 UTC.

Literal string: %n - Newline character (\n) %t - Tab character (\t) %% - Literal ``%'' character

Combination: %c - date and time (%a %b %e %T %Y) %D - Date (%m/%d/%y) %F - The ISO 8601 date format (%Y-%m-%d) %v - VMS date (%e-%^b-%4Y) %x - Same as %D %X - Same as %T %r - 12-hour time (%I:%M:%S %p) %R - 24-hour time (%H:%M) %T - 24-hour time (%H:%M:%S)

This method is similar to strftime() function defined in ISO C and POSIX.

While all directives are locale independent since Ruby 1.9, %Z is platform dependent. So, the result may differ even if the same format string is used in other systems such as C.

%z is recommended over %Z. %Z doesn't identify the timezone. For example, “CST” is used at America/Chicago (-06:00), America/Havana (-05:00), Asia/Harbin (+08:00), Australia/Darwin (+09:30) and Australia/Adelaide (+10:30). Also, %Z is highly dependent on the operating system. For example, it may generate a non ASCII string on Japanese Windows, i.e. the result can be different to “JST”. So the numeric time zone offset, %z, is recommended.

Examples:

t = Time.new(2007,11,19,8,37,48,"-06:00") t.strftime("Printed on %m/%d/%Y")
t.strftime("at %I:%M %p")

Various ISO 8601 formats:

%Y%m%d => 20071119 %F => 2007-11-19 %Y-%m => 2007-11 %Y => 2007 %C => 20 %Y%j => 2007323 %Y-%j => 2007-323 %GW%V%u => 2007W471 %G-W%V-%u => 2007-W47-1 %GW%V => 2007W47 %G-W%V => 2007-W47 %H%M%S => 083748 %T => 08:37:48 %H%M => 0837 %H:%M => 08:37 %H => 08 %H%M%S,%L => 083748,000 %T,%L => 08:37:48,000 %H%M%S.%L => 083748.000 %T.%L => 08:37:48.000 %H%M%S%z => 083748-0600 %T%:z => 08:37:48-06:00 %Y%m%dT%H%M%S%z => 20071119T083748-0600 %FT%T%:z => 2007-11-19 %Y%jT%H%M%S%z => 2007323T083748-0600 %Y-%jT%T%:z => 2007-323T08:37:48-06:00 %GW%V%uT%H%M%S%z => 2007W471T083748-0600 %G-W%V-%uT%T%:z => 2007-W47-1 %Y%m%dT%H%M => 20071119T0837 %FT%R => 2007-11-19T08:37 %Y%jT%H%MZ => 2007323T0837Z %Y-%jT%RZ => 2007-323T08:37Z %GW%V%uT%H%M%z => 2007W471T0837-0600 %G-W%V-%uT%R%:z => 2007-W47-1T08:37-06:00 Calendar date (basic) Calendar date (extended) Calendar date, reduced accuracy, specific month Calendar date, reduced accuracy, specific year Calendar date, reduced accuracy, specific century Ordinal date (basic) Ordinal date (extended) Week date (basic) Week date (extended) Week date, reduced accuracy, specific week (basic) Week date, reduced accuracy, specific week (extended) Local time (basic) Local time (extended) Local time, reduced accuracy, specific minute (basic) Local time, reduced accuracy, specific minute (extended) Local time, reduced accuracy, specific hour Local time with decimal fraction, comma as decimal sign (basic) Local time with decimal fraction, comma as decimal sign (extended) Local time with decimal fraction, full stop as decimal sign (basic) Local time with decimal fraction, full stop as decimal sign (extended) Local time and the difference from UTC (basic) Local time and the difference from UTC (extended) Date and time of day for calendar date (basic) T08:37:48-06:00 Date and time of day for calendar date (extended) Date and time of day for ordinal date (basic) Date and time of day for ordinal date (extended) Date and time of day for week date (basic) T08:37:48-06:00 Date and time of day for week date (extended) Calendar date and local time (basic) Calendar date and local time (extended) Ordinal date and UTC of day (basic) Ordinal date and UTC of day (extended) Week date and local time and difference from UTC (basic) Week date and local time and difference from UTC (extended)

           static VALUE

time_strftime(VALUE time, VALUE format) { struct time_object *tobj; const char *fmt; long len; rb_encoding *enc; VALUE tmp;

GetTimeval(time, tobj);
MAKE_TM_ENSURE(time, tobj, tobj->vtm.yday != 0);
StringValue(format);
if (!rb_enc_str_asciicompat_p(format)) {
    rb_raise(rb_eArgError, "format should have ASCII compatible encoding");
}
tmp = rb_str_tmp_frozen_acquire(format);
fmt = RSTRING_PTR(tmp);
len = RSTRING_LEN(tmp);
enc = rb_enc_get(format);
if (len == 0) {
    rb_warning("strftime called with empty format string");
    return rb_enc_str_new(0, 0, enc);
}
else {
    VALUE str = rb_strftime_alloc(fmt, len, enc, time, &tobj->vtm, tobj->timew,
                                  TZMODE_UTC_P(tobj));
    rb_str_tmp_frozen_release(format, tmp);
    if (!str) rb_raise(rb_eArgError, "invalid format: %"PRIsVALUE, format);
    return str;
}

}

subsec → number click to toggle source

Returns the subsecond for time.

The return value can be a rational number.

t = Time.now
t.subsec

t = Time.new(2000,1,1,2,3,4) t.subsec

Time.new(2000,1,1,0,0,1/3r,"UTC").subsec

           static VALUE

time_subsec(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
return quov(w2v(wmod(tobj->timew, WINT2FIXWV(TIME_SCALE))), INT2FIX(TIME_SCALE));

}

sunday? → true or false click to toggle source

Returns true if time represents Sunday.

t = Time.local(1990, 4, 1)
t.sunday?

           static VALUE

time_sunday(VALUE time) { wday_p(0); }

thursday? → true or false click to toggle source

Returns true if time represents Thursday.

t = Time.local(1995, 12, 21)
t.thursday?

           static VALUE

time_thursday(VALUE time) { wday_p(4); }

to_a → array click to toggle source

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 ::utc or ::local to create a new Time object.

t = Time.now
now = t.to_a

           static VALUE

time_to_a(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
MAKE_TM_ENSURE(time, tobj, tobj->vtm.yday != 0);
return rb_ary_new3(10,
                INT2FIX(tobj->vtm.sec),
                INT2FIX(tobj->vtm.min),
                INT2FIX(tobj->vtm.hour),
                INT2FIX(tobj->vtm.mday),
                INT2FIX(tobj->vtm.mon),
                tobj->vtm.year,
                INT2FIX(tobj->vtm.wday),
                INT2FIX(tobj->vtm.yday),
                tobj->vtm.isdst?Qtrue:Qfalse,
                time_zone(time));

}

to_f → float click to toggle source

Returns the value of time as a floating point number of seconds since the Epoch. The return value approximate the exact value in the Time object because floating point numbers cannot represent all rational numbers exactly.

t = Time.now
t.to_f
t.to_i

Note that IEEE 754 double is not accurate enough to represent the exact number of nanoseconds since the Epoch. (IEEE 754 double has 53bit mantissa. So it can represent exact number of nanoseconds only in `2 ** 53 / 1_000_000_000 / 60 / 60 / 24 = 104.2` days.) When Ruby uses a nanosecond-resolution clock function, such as clock_gettime of POSIX, to obtain the current time, #to_f can lost information of a Time object created with Time.now.

           static VALUE

time_to_f(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
return rb_Float(rb_time_unmagnify_to_float(tobj->timew));

}

to_i → int click to toggle source

Returns the value of time as an integer number of seconds since the Epoch.

If time contains subsecond, they are truncated.

t = Time.now
t.to_i

           static VALUE

time_to_i(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
return w2v(wdiv(tobj->timew, WINT2FIXWV(TIME_SCALE)));

}

to_r → a_rational click to toggle source

Returns the value of time as a rational number of seconds since the Epoch.

t = Time.now
t.to_r

This method is intended to be used to get an accurate value representing the seconds (including subsecond) since the Epoch.

           static VALUE

time_to_r(VALUE time) { struct time_object *tobj; VALUE v;

GetTimeval(time, tobj);
v = rb_time_unmagnify_to_rational(tobj->timew);
if (!RB_TYPE_P(v, T_RATIONAL)) {
    v = rb_Rational1(v);
}
return v;

}

to_s → string click to toggle source

Returns a string representing time. Equivalent to calling strftime with the appropriate format string.

t = Time.now t.to_s
t.strftime "%Y-%m-%d %H:%M:%S %z"

t.utc.to_s
t.strftime "%Y-%m-%d %H:%M:%S UTC"

           static VALUE

time_to_s(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
if (TZMODE_UTC_P(tobj))
    return strftimev("%Y-%m-%d %H:%M:%S UTC", time, rb_usascii_encoding());
else
    return strftimev("%Y-%m-%d %H:%M:%S %z", time, rb_usascii_encoding());

}

tuesday? → true or false click to toggle source

Returns true if time represents Tuesday.

t = Time.local(1991, 2, 19)
t.tuesday?

           static VALUE

time_tuesday(VALUE time) { wday_p(2); }

tv_nsec → int click to toggle source

Returns the number of nanoseconds for the subsecond part of time. The result is a non-negative integer less than 10**9.

t = Time.now
t.nsec

If time has fraction of nanosecond (such as picoseconds), it is truncated.

t = Time.new(2000,1,1,0,0,0.666_777_888_999r) t.nsec

#subsec can be used to obtain the subsecond part exactly.

           static VALUE

time_nsec(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
return rb_to_int(w2v(wmulquoll(wmod(tobj->timew, WINT2WV(TIME_SCALE)), 1000000000, TIME_SCALE)));

}

tv_sec → int click to toggle source

Returns the value of time as an integer number of seconds since the Epoch.

If time contains subsecond, they are truncated.

t = Time.now
t.to_i

           static VALUE

time_to_i(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
return w2v(wdiv(tobj->timew, WINT2FIXWV(TIME_SCALE)));

}

tv_usec → int click to toggle source

Returns the number of microseconds for the subsecond part of time. The result is a non-negative integer less than 10**6.

t = Time.now
t.usec

If time has fraction of microsecond (such as nanoseconds), it is truncated.

t = Time.new(2000,1,1,0,0,0.666_777_888_999r) t.usec

#subsec can be used to obtain the subsecond part exactly.

           static VALUE

time_usec(VALUE time) { struct time_object *tobj; wideval_t w, q, r;

GetTimeval(time, tobj);

w = wmod(tobj->timew, WINT2WV(TIME_SCALE));
wmuldivmod(w, WINT2FIXWV(1000000), WINT2FIXWV(TIME_SCALE), &q, &r);
return rb_to_int(w2v(q));

}

usec → int click to toggle source

Returns the number of microseconds for the subsecond part of time. The result is a non-negative integer less than 10**6.

t = Time.now
t.usec

If time has fraction of microsecond (such as nanoseconds), it is truncated.

t = Time.new(2000,1,1,0,0,0.666_777_888_999r) t.usec

#subsec can be used to obtain the subsecond part exactly.

           static VALUE

time_usec(VALUE time) { struct time_object *tobj; wideval_t w, q, r;

GetTimeval(time, tobj);

w = wmod(tobj->timew, WINT2WV(TIME_SCALE));
wmuldivmod(w, WINT2FIXWV(1000000), WINT2FIXWV(TIME_SCALE), &q, &r);
return rb_to_int(w2v(q));

}

gmtime → time click to toggle source

utc → time

Converts time to UTC (GMT), modifying the receiver.

t = Time.now
t.gmt?
t.gmtime
t.gmt?

t = Time.now
t.utc?
t.utc
t.utc?

           static VALUE

time_gmtime(VALUE time) { struct time_object *tobj; struct vtm vtm;

GetTimeval(time, tobj);
if (TZMODE_UTC_P(tobj)) {
    if (tobj->tm_got)
        return time;
}
else {
    time_modify(time);
}

vtm.zone = str_utc;
GMTIMEW(tobj->timew, &vtm);
tobj->vtm = vtm;

tobj->tm_got = 1;
TZMODE_SET_UTC(tobj);
return time;

}

utc? → true or false click to toggle source

Returns true if time represents a time in UTC (GMT).

t = Time.now
t.utc?
t = Time.gm(2000,"jan",1,20,15,1)
t.utc?

t = Time.now
t.gmt?
t = Time.gm(2000,1,1,20,15,1)
t.gmt?

           static VALUE

time_utc_p(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
if (TZMODE_UTC_P(tobj)) return Qtrue;
return Qfalse;

}

utc_offset → integer click to toggle source

Returns the offset in seconds between the timezone of time and UTC.

t = Time.gm(2000,1,1,20,15,1)
t.gmt_offset
l = t.getlocal
l.gmt_offset

           VALUE

rb_time_utc_offset(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);

if (TZMODE_UTC_P(tobj)) {
    return INT2FIX(0);
}
else {
    MAKE_TM(time, tobj);
    return tobj->vtm.utc_offset;
}

}

wday → integer click to toggle source

Returns an integer representing the day of the week, 0..6, with Sunday == 0.

t = Time.now
t.wday
t.sunday?
t.monday?
t.tuesday?
t.wednesday?
t.thursday?
t.friday?
t.saturday?

           static VALUE

time_wday(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
MAKE_TM_ENSURE(time, tobj, tobj->vtm.wday != VTM_WDAY_INITVAL);
return INT2FIX((int)tobj->vtm.wday);

}

wednesday? → true or false click to toggle source

Returns true if time represents Wednesday.

t = Time.local(1993, 2, 24)
t.wednesday?

           static VALUE

time_wednesday(VALUE time) { wday_p(3); }

yday → integer click to toggle source

Returns an integer representing the day of the year, 1..366.

t = Time.now
t.yday

           static VALUE

time_yday(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
MAKE_TM_ENSURE(time, tobj, tobj->vtm.yday != 0);
return INT2FIX(tobj->vtm.yday);

}

year → integer click to toggle source

Returns the year for time (including the century).

t = Time.now
t.year

           static VALUE

time_year(VALUE time) { struct time_object *tobj;

GetTimeval(time, tobj);
MAKE_TM(time, tobj);
return tobj->vtm.year;

}

zone → string or timezone click to toggle source

Returns the name of the time zone used for time. As of Ruby 1.8, returns “UTC'' rather than “GMT'' for UTC times.

t = Time.gm(2000, "jan", 1, 20, 15, 1) t.zone
t = Time.local(2000, "jan", 1, 20, 15, 1) t.zone

           static VALUE

time_zone(VALUE time) { struct time_object *tobj; VALUE zone;

GetTimeval(time, tobj);
MAKE_TM(time, tobj);

if (TZMODE_UTC_P(tobj)) {
    return rb_usascii_str_new_cstr("UTC");
}
zone = tobj->vtm.zone;
if (NIL_P(zone))
    return Qnil;

if (RB_TYPE_P(zone, T_STRING))
    zone = rb_str_dup(zone);
return zone;

}

Class: Time (Ruby 3.0.0) (original) (raw)

Examples¶ ↑

Creating a new Time instance¶ ↑

Working with an instance of Time¶ ↑

Timezone argument¶ ↑

Auto conversion to Timezone¶ ↑

change case

Working with an instance of Time ¶ ↑