struct Time::Span

• Time::Span
• Struct
• Value
• Object

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

Included Modules

• Comparable(Time::Span)
• Steppable

Defined in:

Constant Summary

MAX = new(seconds: Int64::MAX, nanoseconds: 999999999)

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

ZERO = new(nanoseconds: 0)

Constructors

• .additive_identity : self

  Returns the additive identity of this type.

• .new(*, seconds : Int, nanoseconds : Int)

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

• .new(*, nanoseconds : Int)

  Creates a new Time::Span from the nanoseconds given

• .new(*, weeks : Int = 0, days : Int = 0, hours : Int = 0, minutes : Int = 0, seconds : Int = 0, nanoseconds : Int = 0)

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

Class Method Summary

• .zero : Time::Span

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

Instance Method Summary

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

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

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

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

• #+(other : self) : Time::Span
• #+ : self
• #-(other : self) : Time::Span
• #- : Time::Span
• #/(number : Int) : Time::Span

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

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

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

• #/(other : self) : Float64
• #<=>(other : self)
• #abs : Time::Span

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

• #ago : Time

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

• #days : Int64

  Returns the number of full days in this time span.

• #from_now : Time

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

• #hours : Int32

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

• #inspect(io : IO) : Nil

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

• #microseconds : Int32

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

• #milliseconds : Int32

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

• #minutes : Int32

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

• #nanoseconds : Int32

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

• #negative? : Bool

  Returns true if self represents a negative time span.

• #positive? : Bool

  Returns true if self represents a positive time span.

• #seconds : Int32

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

• #sign : Int32

  Returns the sign of this time span.

• #to_f : Float64

  Alias of #total_seconds.

• #to_i : Int64

  Returns the number of full seconds.

• #total_days : Float64

  Converts to a (possibly fractional) number of days.

• #total_hours : Float64

  Converts to a (possibly fractional) number of hours.

• #total_microseconds : Float64

  Converts to a number of microseconds.

• #total_milliseconds : Float64

  Converts to a number of milliseconds.

• #total_minutes : Float64

  Converts to a (possibly fractional) number of minutes.

• #total_nanoseconds : Float64

  Converts to a number of nanoseconds.

• #total_seconds : Float64

  Converts to a (possibly fractional) number of seconds.

• #total_weeks : Float64

  Converts to a (possibly fractional) number of weeks.

• #zero? : Bool

  Returns true if self represents a span of zero time.

Constructor Detail

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

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

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

Class Method Detail

Instance Method Detail

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

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)"

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

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

(36.hours).total_days # => 1.5

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

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