zoneinfo

Documentation

Index

• type Location
  • func FixedZone(name string, offset int) *Location
  • func LoadLocation(name string) (*Location, error)
  • func LoadLocationFromTZData(name string, data []byte) (*Location, error)
  • func (l *Location) FromLocalClock(local int64) (utc int64)
  • func (l *Location) String() string
  • func (l *Location) ToLocalClock(utc int64) (local int64)

Types

type Location

type Location struct {
	// contains filtered or unexported fields
}

A Location maps time instants to the zone in use at that time. Typically, the Location represents the collection of time offsets in use in a geographical area. For many Locations the time offset varies depending on whether daylight savings time is in use at the time instant.

var UTC *Location = &utcLoc

UTC represents Universal Coordinated Time (UTC).

func FixedZone

func FixedZone(name string, offset int) *Location

FixedZone returns a Location that always uses the given zone name and offset (seconds east of UTC).

func LoadLocation

func LoadLocation(name string) (*Location, error)

LoadLocation returns the Location with the given name.

If the name is "" or "UTC", LoadLocation returns UTC. If the name is "Local", LoadLocation returns Local.

Otherwise, the name is taken to be a location name corresponding to a file in the IANA Time Zone database, such as "America/New_York".

The time zone database needed by LoadLocation may not be present on all systems, especially non-Unix systems. LoadLocation looks in the directory or uncompressed zip file named by the ZONEINFO environment variable, if any, then looks in known installation locations on Unix systems, and finally looks in $GOROOT/lib/time/zoneinfo.zip.

func LoadLocationFromTZData

func LoadLocationFromTZData(name string, data []byte) (*Location, error)

LoadLocationFromTZData returns a Location with the given name initialized from the IANA Time Zone database-formatted data. The data should be in the format of a standard IANA time zone file (for example, the content of /etc/localtime on Unix systems).

func (*Location) FromLocalClock

func (l *Location) FromLocalClock(local int64) (utc int64)

FromLocalClock transposes the local timestamp from a time in the location to an equivalent clock time in UTC.

func (*Location) String

func (l *Location) String() string

String returns a descriptive name for the time zone information, corresponding to the name argument to LoadLocation or FixedZone.

func (*Location) ToLocalClock

func (l *Location) ToLocalClock(utc int64) (local int64)

ToLocalClock transposes the utc timestamp from a time in the UTC location to an equivalent clock time in the current location.