Idris2Doc : IotaTime.TimeZone

IotaTime.TimeZone

(source)

Reexports

import public IotaTime.TimeZone.Core
import public IotaTime.TimeZone.Error
import public IotaTime.Tzdb.Metadata

Definitions

record TimeZoneProviderRep : Type
Totality: total
Visibility: export
Constructor: 
MkTimeZoneProviderRep : TimeZoneProviderRep -> TimeZoneProviderRep

Projection: 
.providerRepresentation : TimeZoneProviderRep -> TimeZoneProviderRep
TimeZoneProvider : Type
  An opaque source of time zones and associated metadata.

Totality: total
Visibility: public export
timeZoneProvider : IO (Either TzdbError TimeZone) -> (String -> IO (Either TzdbError TimeZone)) -> IO (Either TzdbError TimeZone) -> IO (Either TzdbError (List String)) -> IO (Either TzdbError TzdbMetadata) -> TimeZoneProvider
  Build a provider from its loading operations.

Totality: total
Visibility: public export
record TimeZoneCachePolicyRep : Type
Totality: total
Visibility: export
Constructor: 
MkTimeZoneCachePolicyRep : TimeZoneCachePolicyRep -> TimeZoneCachePolicyRep

Projection: 
.cachePolicyRepresentation : TimeZoneCachePolicyRep -> TimeZoneCachePolicyRep
TimeZoneCachePolicy : Type
  An opaque selection of provider results to cache.

Totality: total
Visibility: public export
timeZoneCachePolicy : Bool -> Bool -> Bool -> Bool -> TimeZoneCachePolicy
  Select which successful provider queries are retained in memory.

Totality: total
Visibility: public export
defaultTimeZoneCachePolicy : TimeZoneCachePolicy
  Cache named zones, discovery, and metadata while keeping the local zone live.

Totality: total
Visibility: public export
cachedTimeZoneProvider : TimeZoneCachePolicy -> TimeZoneProvider -> IO TimeZoneProvider
  Wrap a provider in caller-owned caches for selected successful operations.

Totality: total
Visibility: public export
unixTimeZoneProvider : TimeZoneProvider
  The built-in Unix filesystem provider.

Totality: total
Visibility: public export
systemTimeZoneProvider : TimeZoneProvider
  The provider selected for the current operating system.

Totality: total
Visibility: public export
windowsSnapshotTimeZoneProvider : IO (Either TzdbError TimeZoneProvider)
  Snapshot the native Windows registry into an immutable provider.

Totality: total
Visibility: public export
utcWith : TimeZoneProvider -> IO (Either TzdbError TimeZone)
  Load UTC through an explicit provider.

Totality: total
Visibility: public export
timeZoneWith : TimeZoneProvider -> String -> IO (Either TzdbError TimeZone)
  Load a named zone through an explicit provider.

Totality: total
Visibility: public export
localZoneWith : TimeZoneProvider -> IO (Either TzdbError TimeZone)
  Load the local zone through an explicit provider.

Totality: total
Visibility: public export
availableZonesWith : TimeZoneProvider -> IO (Either TzdbError (List String))
  Enumerate zones through an explicit provider.

Totality: total
Visibility: public export
metadataWith : TimeZoneProvider -> IO (Either TzdbError TzdbMetadata)
  Query version and identifier metadata through an explicit provider.

Totality: total
Visibility: public export
utc : IO (Either TzdbError TimeZone)
  Load UTC from the platform time-zone database.

Totality: total
Visibility: public export
timeZone : String -> IO (Either TzdbError TimeZone)
  Load a named zone from the platform time-zone database.

Totality: total
Visibility: public export
localZone : IO (Either TzdbError TimeZone)
  Load the locally configured platform zone.

Totality: total
Visibility: public export
availableZones : IO (Either TzdbError (List String))
  List every zone available through the platform provider.

Totality: total
Visibility: public export
metadata : IO (Either TzdbError TzdbMetadata)
  Query version, aliases, and platform mappings from the system provider.

Totality: total
Visibility: public export