timezone

Documentation

Overview

Package timezone represents the imported interface "wasi:clocks/timezone@0.2.1".

Index

• func UtcOffset(when DateTime) (result int32)
• type DateTime
• type TimezoneDisplay
  • func Display(when DateTime) (result TimezoneDisplay)

Functions

func UtcOffset

func UtcOffset(when DateTime) (result int32)

UtcOffset represents the imported function "utc-offset".

The same as `display`, but only return the UTC offset.

utc-offset: func(when: datetime) -> s32

Types

type DateTime

type DateTime = wallclock.DateTime

DateTime represents the type alias "wasi:clocks/timezone@0.2.1#datetime".

See wallclock.DateTime for more information.

type TimezoneDisplay

type TimezoneDisplay struct {

	// The number of seconds difference between UTC time and the local
	// time of the timezone.
	//
	// The returned value will always be less than 86400 which is the
	// number of seconds in a day (24*60*60).
	//
	// In implementations that do not expose an actual time zone, this
	// should return 0.
	UtcOffset int32

	// The abbreviated name of the timezone to display to a user. The name
	// `UTC` indicates Coordinated Universal Time. Otherwise, this should
	// reference local standards for the name of the time zone.
	//
	// In implementations that do not expose an actual time zone, this
	// should be the string `UTC`.
	//
	// In time zones that do not have an applicable name, a formatted
	// representation of the UTC offset may be returned, such as `-04:00`.
	Name string

	// Whether daylight saving time is active.
	//
	// In implementations that do not expose an actual time zone, this
	// should return false.
	InDaylightSavingTime bool
	// contains filtered or unexported fields
}

TimezoneDisplay represents the record "wasi:clocks/timezone@0.2.1#timezone-display".

Information useful for displaying the timezone of a specific `datetime`.

This information may vary within a single `timezone` to reflect daylight saving time adjustments.

record timezone-display {
	utc-offset: s32,
	name: string,
	in-daylight-saving-time: bool,
}

func Display

func Display(when DateTime) (result TimezoneDisplay)

Display represents the imported function "display".

Return information needed to display the given `datetime`. This includes the UTC offset, the time zone name, and a flag indicating whether daylight saving time is active.

If the timezone cannot be determined for the given `datetime`, return a `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight saving time.

display: func(when: datetime) -> timezone-display