struct Time::Span

Overview

Time::Span represents one period of time.

A Time::Span initializes with the specified period. Different numbers of arguments generate a Time::Span in different length. Check all #new methods for details.

Time::Span.new(nanoseconds: 10_000)                           # => 00:00:00.000010000
Time::Span.new(hours: 10, minutes: 10, seconds: 10)           # => 10:10:10
Time::Span.new(days: 10, hours: 10, minutes: 10, seconds: 10) # => 10.10:10:10

Calculation between Time also returns a Time::Span.

span = Time.utc(2015, 10, 10) - Time.utc(2015, 9, 10)
span       # => 30.00:00:00
span.class # => Time::Span

Inspection:

span = Time::Span.new(hours: 20, minutes: 10, seconds: 10)
span.hours   # => 20
span.minutes # => 10
span.seconds # => 10

Calculation:

a = Time::Span.new(hours: 20, minutes: 10, seconds: 10)
b = Time::Span.new(hours: 10, minutes: 10, seconds: 10)
c = a - b # => 10:00:00
c.hours   # => 10

time/span.cr

Constant Summary

MAX = new(seconds: Int64::MAX, nanoseconds: 999999999)
MIN = new(seconds: Int64::MIN, nanoseconds: -999999999)
ZERO = new(nanoseconds: 0)

Constructor Detail

Returns the additive identity of this type.

This is .zero.

def self.new(*, seconds : Int, nanoseconds : Int) #

Creates a new Time::Span from seconds and nanoseconds.

Nanoseconds get normalized in the range of 0...1_000_000_000, the nanosecond overflow gets added as seconds.

Time::Span.new(seconds: 30)                 # => 00:00:30
Time::Span.new(seconds: 5, nanoseconds: 12) # => 00:00:05.000000012

def self.new(*, nanoseconds : Int) #

Creates a new Time::Span from the nanoseconds given

Nanoseconds get normalized in the range of 0...1_000_000_000, the nanosecond overflow gets added as seconds.

Time::Span.new(nanoseconds: 500_000_000)   # => 00:00:00.500000000
Time::Span.new(nanoseconds: 5_500_000_000) # => 00:00:05.500000000

def self.new(*, days : Int = 0, hours : Int = 0, minutes : Int = 0, seconds : Int = 0, nanoseconds : Int = 0) #

Creates a new Time::Span from the days, hours, minutes, seconds and nanoseconds given

Any time unit can be omitted.

Time::Span.new(days: 1)                                                   # => 1.00:00:00
Time::Span.new(days: 1, hours: 2, minutes: 3)                             # => 01:02:03
Time::Span.new(days: 1, hours: 2, minutes: 3, seconds: 4, nanoseconds: 5) # => 1.02:03:04.000000005

Class Method Detail

def self.zero : Time::Span #

Creates a new Time::Span representing a span of zero time.

Instance Method Detail

def *(number : Int) : Time::Span #

Returns a Time::Span that is number times longer.

def *(number : Float) : Time::Span #

Returns a Time::Span that is number times longer.

def +(other : self) : Time::Span #

def + : self #

def -(other : self) : Time::Span #

def - : Time::Span #

def /(number : Int) : Time::Span #

Returns a Time::Span that is divided by number.

def /(number : Float) : Time::Span #

Returns a Time::Span that is divided by number.

def /(other : self) : Float64 #

def <=>(other : self) #

def abs : Time::Span #

Returns the absolute (non-negative) amount of time this Time::Span represents by removing the sign.

def ago : Time #

Returns a Time that happens earlier by self than the current time.

def days : Int64 #

Returns the number of full days in this time span.

(5.days + 25.hours).days # => 6_i64

def from_now : Time #

Returns a Time that happens later by self than the current time.

def hours : Int32 #

Returns the number of full hours of the day (0..23) in this time span.

def inspect(io : IO) : Nil #
Description copied from struct Struct

Appends this struct's name and instance variables names and values to the given IO.

struct Point
def initialize(@x : Int32, @y : Int32)
end
end

p1 = Point.new 1, 2
p1.to_s    # "Point(@x=1, @y=2)"
p1.inspect # "Point(@x=1, @y=2)"

def microseconds : Int32 #

Returns the number of microseconds of the second (0..999999) in this time span.

def milliseconds : Int32 #

Returns the number of milliseconds of the second (0..999) in this time span.

def minutes : Int32 #

Returns the number of full minutes of the hour (0..59) in this time span.

def nanoseconds : Int32 #

Returns the number of nanoseconds of the second (0..999_999_999) in this time span.

def negative? : Bool #

Returns true if self represents a negative time span.

2.hours.negative? # => false
0.days.negative?  # => false
-3.days.negative? # => true

def positive? : Bool #

Returns true if self represents a positive time span.

2.hours.positive? # => true
0.days.positive?  # => false
-3.days.positive? # => false

def seconds : Int32 #

Returns the number of full seconds of the minute (0..59) in this time span.

def sign : Int32 #

Returns the sign of this time span.

Values are -1, 0, 1 if self is smaller, equal, bigger compared to ZERO.

def to_f : Float64 #

Alias of #total_seconds.

def to_i : Int64 #

Returns the number of full seconds.

def total_days : Float64 #

Converts to a (possibly fractional) number of days.

(36.hours).total_days # => 1.5

def total_hours : Float64 #

Converts to a (possibly fractional) number of hours.

def total_microseconds : Float64 #

Converts to a number of microseconds.

def total_milliseconds : Float64 #

Converts to a number of milliseconds.

def total_minutes : Float64 #

Converts to a (possibly fractional) number of minutes.

def total_nanoseconds : Float64 #

Converts to a number of nanoseconds.

def total_seconds : Float64 #

Converts to a (possibly fractional) number of seconds.

def total_weeks : Float64 #

Converts to a (possibly fractional) number of weeks.

(4.weeks + 5.days + 6.hours).total_weeks # => 4.75

def zero? : Bool #

Returns true if self represents a span of zero time.

2.hours.zero?  # => false
0.days.zero?   # => true
1.second.zero? # => false