class TZInfo::TimezonePeriod

A period of time in a timezone where the same offset from UTC applies.

All the methods that take times accept instances of Time, DateTime or integer timestamps.

Attributes

end_transition [R]

The TimezoneTransitionInfo that defines the end of this TimezonePeriod (may be nil if unbounded).

offset [R]

The TimezoneOffsetInfo for this period.

start_transition [R]

The TimezoneTransitionInfo that defines the start of this TimezonePeriod (may be nil if unbounded).

Public Class Methods

new (start_transition, end_transition, offset = nil)

Source

# File lib/tzinfo/timezone_period.rb, line 41
def initialize(start_transition, end_transition, offset = nil)
  @start_transition = start_transition
  @end_transition = end_transition
  
  if offset
    raise ArgumentError, 'Offset specified with transitions' if @start_transition || @end_transition
    @offset = offset
  else
    if @start_transition 
      @offset = @start_transition.offset
    elsif @end_transition
      @offset = @end_transition.previous_offset
    else
      raise ArgumentError, 'No offset specified and no transitions to determine it from'
    end
  end
  
  @utc_total_offset_rational = nil      
end

Initializes a new TimezonePeriod.

Public Instance Methods

== (p)

Source

# File lib/tzinfo/timezone_period.rb, line 167
def ==(p)
  p.kind_of?(TimezonePeriod) &&
    start_transition == p.start_transition &&
    end_transition == p.end_transition &&
    offset == p.offset
end

Returns true if this TimezonePeriod is equal to p. This compares the start_transition, end_transition and offset using ==.

abbreviation ()

Source

# File lib/tzinfo/timezone_period.rb, line 76
def abbreviation
  @offset.abbreviation
end

The identifier of this period, e.g. “GMT” (Greenwich Mean Time) or “BST” (British Summer Time) for “Europe/London”. The returned identifier is a symbol.

Also aliased as: zone_identifier

dst? ()

Source

# File lib/tzinfo/timezone_period.rb, line 117
def dst?
  @offset.dst?
end

true if daylight savings is in effect for this period; otherwise false.

eql? (p)

Source

# File lib/tzinfo/timezone_period.rb, line 176
def eql?(p)
  p.kind_of?(TimezonePeriod) &&
    start_transition.eql?(p.start_transition) &&
    end_transition.eql?(p.end_transition) &&
    offset.eql?(p.offset)
end

Returns true if this TimezonePeriods is equal to p. This compares the start_transition, end_transition and offset using eql?

hash ()

Source

# File lib/tzinfo/timezone_period.rb, line 184
def hash
  result = @start_transition.hash ^ @end_transition.hash
  result ^= @offset.hash unless @start_transition || @end_transition
  result       
end

Returns a hash of this TimezonePeriod.

inspect ()

Source

# File lib/tzinfo/timezone_period.rb, line 191
def inspect
  result = "#<#{self.class}: #{@start_transition.inspect},#{@end_transition.inspect}"
  result << ",#{@offset.inspect}>" unless @start_transition || @end_transition
  result + '>'
end

Returns internal object state as a programmer-readable string.

local_after_start? (local)

Source

# File lib/tzinfo/timezone_period.rb, line 145
def local_after_start?(local)
  !@start_transition || @start_transition.local_start <= local
end

true if the given local DateTime is after the start of the period (inclusive); otherwise false.

local_before_end? (local)

Source

# File lib/tzinfo/timezone_period.rb, line 151
def local_before_end?(local)
  !@end_transition || @end_transition.local_end > local
end

true if the given local DateTime is before the end of the period (exclusive); otherwise false.

local_end ()

Source

# File lib/tzinfo/timezone_period.rb, line 112
def local_end
  @end_transition ? @end_transition.local_end.to_datetime : nil
end

The end time of the period in local time as a DateTime. May be nil if unbounded.

local_start ()

Source

# File lib/tzinfo/timezone_period.rb, line 106
def local_start
  @start_transition ? @start_transition.local_start.to_datetime : nil
end

The start time of the period in local time as a DateTime. May be nil if unbounded.

std_offset ()

Source

# File lib/tzinfo/timezone_period.rb, line 69
def std_offset
  @offset.std_offset
end

Offset from the local time where daylight savings is in effect (seconds). E.g.: utc_offset could be -5 hours. Normally, std_offset would be 0. During daylight savings, std_offset would typically become +1 hours.

to_local (utc)

Source

# File lib/tzinfo/timezone_period.rb, line 156
def to_local(utc)
  @offset.to_local(utc)
end

Converts a UTC DateTime to local time based on the offset of this period.

to_utc (local)

Source

# File lib/tzinfo/timezone_period.rb, line 161
def to_utc(local)
  @offset.to_utc(local)
end

Converts a local DateTime to UTC based on the offset of this period.

utc_after_start? (utc)

Source

# File lib/tzinfo/timezone_period.rb, line 128
def utc_after_start?(utc)
  !@start_transition || @start_transition.at <= utc
end

true if the given UTC DateTime is after the start of the period (inclusive); otherwise false.

utc_before_end? (utc)

Source

# File lib/tzinfo/timezone_period.rb, line 134
def utc_before_end?(utc)
  !@end_transition || @end_transition.at > utc
end

true if the given UTC DateTime is before the end of the period (exclusive); otherwise false.

utc_end ()

Source

# File lib/tzinfo/timezone_period.rb, line 100
def utc_end
  @end_transition ? @end_transition.at.to_datetime : nil
end

The end time of the period in UTC as a DateTime. May be nil if unbounded.

utc_offset ()

Source

# File lib/tzinfo/timezone_period.rb, line 62
def utc_offset
  @offset.utc_offset
end

Base offset of the timezone from UTC (seconds).

utc_start ()

Source

# File lib/tzinfo/timezone_period.rb, line 95
def utc_start
  @start_transition ? @start_transition.at.to_datetime : nil
end

The start time of the period in UTC as a DateTime. May be nil if unbounded.

utc_total_offset ()

Source

# File lib/tzinfo/timezone_period.rb, line 82
def utc_total_offset
  @offset.utc_total_offset
end

Total offset from UTC (seconds). Equal to utc_offset + std_offset.

utc_total_offset_rational ()

Source

# File lib/tzinfo/timezone_period.rb, line 87
def utc_total_offset_rational
  unless @utc_total_offset_rational
    @utc_total_offset_rational = OffsetRationals.rational_for_offset(utc_total_offset) 
  end
  @utc_total_offset_rational
end

Total offset from UTC (days). Result is a Rational.

valid_for_local? (local)

Source

# File lib/tzinfo/timezone_period.rb, line 139
def valid_for_local?(local)      
  local_after_start?(local) && local_before_end?(local) 
end

true if this period is valid for the given local DateTime; otherwise false.

valid_for_utc? (utc)

Source

# File lib/tzinfo/timezone_period.rb, line 122
def valid_for_utc?(utc)
  utc_after_start?(utc) && utc_before_end?(utc) 
end

true if this period is valid for the given UTC DateTime; otherwise false.

zone_identifier ()

Alias for: abbreviation