core/time/timezone package | Odin Programming Language

Timezone lookup.

Collection Info

View Source

Collection: core
Path: time/timezone
Entries: 24

Constants 3

Jump to Constants

BIG_BANG_ISH TWO_AM TZIF_MAGIC

Types 5

Jump to Types

Leapsecond_Record Local_Time_Type Sun_Shift TZif_Header TZif_Version

Procedures 16

Jump to Procedures

datetime_to_str datetime_to_tz datetime_to_utc dst dst_unsafe load_tzif_file parse_posix_rrule parse_posix_tz parse_tzif region_destroy region_load region_load_from_buffer region_load_from_file rrule_destroy shortname shortname_unsafe

Procedure Groups 0

Variables 0

Source Files

(hidden platform specific files)

Constants

BIG_BANG_ISH #

Source

BIG_BANG_ISH :: -0x800000000000000

TWO_AM #

Source

TWO_AM :: 2 * 60 * 60

TZIF_MAGIC #

Source

TZIF_MAGIC :: u32be(0x545A6966)

'TZif'

Types

Leapsecond_Record #

Source

Leapsecond_Record :: Leapsecond_Record

Local_Time_Type #

Source

Local_Time_Type :: Local_Time_Type

Sun_Shift #

Source

Sun_Shift :: Sun_Shift

TZif_Header #

Source

TZif_Header :: TZif_Header

TZif_Version #

Source

TZif_Version :: TZif_Version

Procedures

datetime_to_str #

Source

datetime_to_str :: proc(dt: DateTime, allocator := context.allocator) -> string {…}

datetime_to_tz #

Source

datetime_to_tz :: proc(dt: DateTime, tz: ^TZ_Region) -> (out: DateTime, success: bool) #optional_ok {…}

Converts a datetime on one timezone to another timezone Inputs: - dt: The input datetime - tz: The timezone to convert to NOTE: tz will be referenced in the result datetime, so it must stay alive/allocated as long as it is used Returns: - out: The converted datetime - success: `false` if the datetime was invalid

datetime_to_utc #

Source

datetime_to_utc :: proc(dt: DateTime) -> (out: DateTime, success: bool) #optional_ok {…}

dst #

Source

dst :: proc(dt: DateTime) -> (is_dst: bool, success: bool) #optional_ok {…}

Checks DST for a given date. Inputs: - dt: The input datetime Returns: - is_dst: returns `true` if dt is in daylight savings time, `false` if not - success: returns `false` if the passed datetime is invalid

dst_unsafe #

Source

dst_unsafe :: proc(dt: DateTime) -> bool {…}

Checks DST for a given date. WARNING: This is unsafe because it doesn't check if your datetime is valid or if your region contains a valid record. Inputs: - dt: The input datetime Returns: - is_dst: returns `true` if dt is in daylight savings time, `false` if not

load_tzif_file #

Source

load_tzif_file :: proc(filename: string, region_name: string, allocator := context.allocator) -> (out: ^TZ_Region, ok: bool) {…}

parse_posix_rrule #

Source

parse_posix_rrule :: proc(str: string) -> (out: TZ_Transition_Date, idx: int, ok: bool) {…}

parse_posix_tz #

Source

parse_posix_tz :: proc(posix_tz: string, allocator := context.allocator) -> (out: TZ_RRule, ok: bool) {…}

parse_tzif #

Source

parse_tzif :: proc(_buffer: []u8, region_name: string, allocator := context.allocator) -> (out: ^TZ_Region, ok: bool) {…}

region_destroy #

Source

region_destroy :: proc(region: ^TZ_Region, allocator := context.allocator) {…}

region_load #

Source

region_load :: proc(reg: string, allocator := context.allocator) -> (out_reg: ^TZ_Region, ok: bool) {…}

region_load_from_buffer #

Source

region_load_from_buffer :: proc(buffer: []u8, reg: string, allocator := context.allocator) -> (out_reg: ^TZ_Region, ok: bool) {…}

region_load_from_file #

Source

region_load_from_file :: proc(file_path, reg: string, allocator := context.allocator) -> (out_reg: ^TZ_Region, ok: bool) {…}

rrule_destroy #

Source

rrule_destroy :: proc(rrule: TZ_RRule, allocator := context.allocator) {…}

shortname #

Source

shortname :: proc(dt: DateTime) -> (name: string, success: bool) #optional_ok {…}

Gets the timezone abbreviation/shortname for a given date. (ex: "PDT") Inputs: - dt: The datetime containing the date, time, and timezone pointer for the lookup NOTE: The lifetime of name matches the timezone it was pulled from. Returns: - name: The timezone abbreviation - success: returns `false` if the passed datetime is invalid

shortname_unsafe #

Source

shortname_unsafe :: proc(dt: DateTime) -> string {…}

Gets the timezone abbreviation/shortname for a given date. (ex: "PDT") WARNING: This is unsafe because it doesn't check if your datetime is valid or if your region contains a valid record. Inputs: - dt: The input datetime NOTE: The lifetime of name matches the timezone it was pulled from. Returns: - name: The timezone abbreviation