Idris2Doc : System.Posix.Time

System.Posix.Time

(source)
Reexports
import public Data.C.Integer
import public System.Clock
import public System.Posix.Errno
import public System.Posix.Time.Types
import public System.Posix.Timer.Types
Definitions
.secs : Clock t -> TimeT
  Totality: total
  Visibility: export
.nsecs : Clock t -> TimeT
  Totality: total
  Visibility: export
record STimespec : Type -> Type
  A wrapper around a `struct timespec` pointer.

  Totality: total
  Visibility: export
  Constructor: 
TS : AnyPtr -> STimespec s

  Projection: 
.ptr : STimespec s -> AnyPtr

  Hints:
  
SizeOf (STimespec s)
  
Struct STimespec
0 IOTimespec : Type
  Totality: total
  Visibility: public export
sec : STimespec s -> F1 s TimeT
  Reads the `tv_sec` field of a `timespec` pointer.

  Totality: total
  Visibility: export
nsec : STimespec s -> F1 s NsecT
  Reads the `tv_nsec` field of a `timespec` pointer.

  Totality: total
  Visibility: export
setSec : STimespec s -> TimeT -> F1 s ()
  Sets the `tv_sec` field of a `timespec` pointer.

  Totality: total
  Visibility: export
setNsec : STimespec s -> NsecT -> F1 s ()
  Sets the `tv_nsec` field of a `timespec` pointer.

  Totality: total
  Visibility: export
toClock : STimespec s -> F1 s (Clock t)
  Convert a `STimespec` to a `Clock t`

  Totality: total
  Visibility: export
withTimespec : Clock t -> (IOTimespec -> EPrim a) -> EPrim a
  Totality: total
  Visibility: export
convertClock : Convert (Clock t)
  Totality: total
  Visibility: export
record STimeval : Type -> Type
  Totality: total
  Visibility: export
  Constructor: 
STV : AnyPtr -> STimeval s

  Projection: 
.ptr : STimeval s -> AnyPtr

  Hints:
  
SizeOf (STimeval s)
  
Struct STimeval
0 IOTimeval : Type
  Totality: total
  Visibility: public export
sec : STimeval s -> F1 s TimeT
  Totality: total
  Visibility: export
usec : STimeval s -> F1 s SusecondsT
  Totality: total
  Visibility: export
setsec : STimeval s -> TimeT -> F1 s ()
  Totality: total
  Visibility: export
setusec : STimeval s -> SusecondsT -> F1 s ()
  Totality: total
  Visibility: export
record Timeval : Type
  Pure alternative to the `STimeval` struct.

  Totality: total
  Visibility: public export
  Constructor: 
TV : TimeT -> SusecondsT -> Timeval

  Projections:
  
.sec : Timeval -> TimeT
  
.usec : Timeval -> SusecondsT

  Hints:
  
Convert Timeval
  
Eq Timeval
  
Show Timeval
.sec : Timeval -> TimeT
  Totality: total
  Visibility: public export
sec : Timeval -> TimeT
  Totality: total
  Visibility: public export
.usec : Timeval -> SusecondsT
  Totality: total
  Visibility: public export
usec : Timeval -> SusecondsT
  Totality: total
  Visibility: public export
stimeval : Timeval -> F1 s (STimeval s)
  Totality: total
  Visibility: export
timeval : STimeval s -> F1 s Timeval
  Totality: total
  Visibility: export
convertTimeval : Convert Timeval
  Totality: total
  Visibility: export
record Itimerval : Type -> Type
  Totality: total
  Visibility: export
  Constructor: 
ITV : AnyPtr -> Itimerval s

  Projection: 
.ptr : Itimerval s -> AnyPtr

  Hints:
  
SizeOf (Itimerval s)
  
Struct Itimerval
0 IOTimerval : Type
  Totality: total
  Visibility: public export
interval : Itimerval s -> F1 s (STimeval s)
  Totality: total
  Visibility: export
value : Itimerval s -> F1 s (STimeval s)
  Totality: total
  Visibility: export
setinterval : Itimerval s -> STimeval s -> F1 s ()
  Totality: total
  Visibility: export
setvalue : Itimerval s -> STimeval s -> F1 s ()
  Totality: total
  Visibility: export
record Timerval : Type
  Pure alternative to the `Itimerval` struct.

  Totality: total
  Visibility: public export
  Constructor: 
TRV : Timeval -> Timeval -> Timerval

  Projections:
  
.interval : Timerval -> Timeval
  
.value : Timerval -> Timeval

  Hints:
  
Convert Timerval
  
Eq Timerval
  
Show Timerval
.interval : Timerval -> Timeval
  Totality: total
  Visibility: public export
interval : Timerval -> Timeval
  Totality: total
  Visibility: public export
.value : Timerval -> Timeval
  Totality: total
  Visibility: public export
value : Timerval -> Timeval
  Totality: total
  Visibility: public export
itimerval : Timerval -> F1 s (Itimerval s)
  Creates and sets the fields of a `Itimerval` pointer.
  
  The allocated memory must be freed via `freeStruct`.

  Totality: total
  Visibility: export
timerval : Itimerval s -> F1 s Timerval
  Totality: total
  Visibility: export
convertTimerval : Convert Timerval
  Totality: total
  Visibility: export
get_itimerspec_it_interval : AnyPtr -> PrimIO AnyPtr
get_itimerspec_it_value : AnyPtr -> PrimIO AnyPtr
set_itimerspec_it_interval : AnyPtr -> AnyPtr -> PrimIO ()
set_itimerspec_it_value : AnyPtr -> AnyPtr -> PrimIO ()
record Itimerspec : Type -> Type
  Note: Also this is POSIX compliant, it is not available on
  MacOS (Darwin). Idris programs making use of this might fail on
  Darwin during code generation.

  Totality: total
  Visibility: export
  Constructor: 
ITS : AnyPtr -> Itimerspec s

  Projection: 
.ptr : Itimerspec s -> AnyPtr

  Hints:
  
SizeOf (Itimerspec s)
  
Struct Itimerspec
0 IOTimerspec : Type
  Totality: total
  Visibility: public export
interval : Itimerspec s -> F1 s (STimespec s)
  Totality: total
  Visibility: export
value : Itimerspec s -> F1 s (STimespec s)
  Totality: total
  Visibility: export
setinterval : Itimerspec s -> STimespec s -> F1 s ()
  Totality: total
  Visibility: export
setvalue : Itimerspec s -> STimespec s -> F1 s ()
  Totality: total
  Visibility: export
itimerspec : TimeT -> NsecT -> TimeT -> NsecT -> F1 s (Itimerspec s)
  Creates and sets the fields of a `Itimerspec` pointer.
  
  The allocated memory must be freed via `freeStruct`.

  Totality: total
  Visibility: export
record Timerspec : Type
  Pure alternative to the `Itimerspec` struct.

  Totality: total
  Visibility: public export
  Constructor: 
TS : Clock Duration -> Clock Duration -> Timerspec

  Projections:
  
.interval : Timerspec -> Clock Duration
  
.value : Timerspec -> Clock Duration

  Hints:
  
Convert Timerspec
  
Eq Timerspec
  
Show Timerspec
.interval : Timerspec -> Clock Duration
  Totality: total
  Visibility: public export
interval : Timerspec -> Clock Duration
  Totality: total
  Visibility: public export
.value : Timerspec -> Clock Duration
  Totality: total
  Visibility: public export
value : Timerspec -> Clock Duration
  Totality: total
  Visibility: public export
timerspec : Itimerspec s -> F1 s Timerspec
  Totality: total
  Visibility: export
duration : TimeT -> NsecT -> Clock Duration
  Totality: total
  Visibility: export
convTimerspec : Convert Timerspec
  Totality: total
  Visibility: export
get_tm_sec : AnyPtr -> PrimIO Bits8
get_tm_min : AnyPtr -> PrimIO Bits8
get_tm_hour : AnyPtr -> PrimIO Bits8
get_tm_mday : AnyPtr -> PrimIO Bits8
get_tm_mon : AnyPtr -> PrimIO Bits8
get_tm_year : AnyPtr -> PrimIO Int32
get_tm_wday : AnyPtr -> PrimIO Bits8
get_tm_yday : AnyPtr -> PrimIO Bits16
get_tm_isdst : AnyPtr -> PrimIO Int8
prim__gmtime_r : TimeT -> AnyPtr -> PrimIO ()
prim__localtime_r : TimeT -> AnyPtr -> PrimIO ()
ctime : TimeT -> String
  Converts time to a nicely formatted string.
prim__asctime_r : Bits8 -> Bits8 -> Bits8 -> Bits8 -> Bits8 -> Int32 -> Bits8 -> Bits16 -> Int8 -> String
prim__mktime : Bits8 -> Bits8 -> Bits8 -> Bits8 -> Bits8 -> Int32 -> Bits8 -> Bits16 -> Int8 -> TimeT
record STm : Type -> Type
  Note: Although this is POSIX compliant, it is not available on
  MacOS (Darwin). Idris programs making use of this might fail on
  Darwin during code generation.

  Totality: total
  Visibility: export
  Constructor: 
STM : AnyPtr -> STm s

  Projection: 
.ptr : STm s -> AnyPtr

  Hints:
  
SizeOf (STm s)
  
Struct STm
getsec : STm s -> F1 s Bits8
  Totality: total
  Visibility: export
getmin : STm s -> F1 s Bits8
  Totality: total
  Visibility: export
gethour : STm s -> F1 s Bits8
  Totality: total
  Visibility: export
getmday : STm s -> F1 s Bits8
  Totality: total
  Visibility: export
getmon : STm s -> F1 s Bits8
  Totality: total
  Visibility: export
getyear : STm s -> F1 s Int32
  Totality: total
  Visibility: export
getwday : STm s -> F1 s Bits8
  Totality: total
  Visibility: export
getyday : STm s -> F1 s Bits16
  Totality: total
  Visibility: export
getisdst : STm s -> F1 s Int8
  Totality: total
  Visibility: export
record Tm : Type
  Pure alternative to the `STm` struct.
  
  Dissection of a `Clock t` into its time components.

  Totality: total
  Visibility: public export
  Constructor: 
TM : Bits8 -> Bits8 -> Bits8 -> Bits8 -> Bits8 -> Int32 -> Bits8 -> Bits16 -> Bool -> Tm

  Projections:
  
.hour : Tm -> Bits8
  Hour of day (0 - 23)
  
.isdst : Tm -> Bool
  `True` if daylight safing time is active
  
.mday : Tm -> Bits8
  Day of month (1 - 31)
  
.min : Tm -> Bits8
  Minute of hour (0 - 59)
  
.mon : Tm -> Bits8
  Month (0 - 11)
  
.sec : Tm -> Bits8
  Second of minute (0 - 60; could be a leap second)
  
.wday : Tm -> Bits8
  Day of week (Sunday = 0)
  
.yday : Tm -> Bits16
  Day of year (0 - 365; 1 Jan = 0)
  
.year : Tm -> Int32
  Year since 1900

  Hints:
  
Convert Tm
  
Eq Tm
  
Show Tm
.sec : Tm -> Bits8
  Second of minute (0 - 60; could be a leap second)

  Totality: total
  Visibility: public export
sec : Tm -> Bits8
  Second of minute (0 - 60; could be a leap second)

  Totality: total
  Visibility: public export
.min : Tm -> Bits8
  Minute of hour (0 - 59)

  Totality: total
  Visibility: public export
min : Tm -> Bits8
  Minute of hour (0 - 59)

  Totality: total
  Visibility: public export
.hour : Tm -> Bits8
  Hour of day (0 - 23)

  Totality: total
  Visibility: public export
hour : Tm -> Bits8
  Hour of day (0 - 23)

  Totality: total
  Visibility: public export
.mday : Tm -> Bits8
  Day of month (1 - 31)

  Totality: total
  Visibility: public export
mday : Tm -> Bits8
  Day of month (1 - 31)

  Totality: total
  Visibility: public export
.mon : Tm -> Bits8
  Month (0 - 11)

  Totality: total
  Visibility: public export
mon : Tm -> Bits8
  Month (0 - 11)

  Totality: total
  Visibility: public export
.year : Tm -> Int32
  Year since 1900

  Totality: total
  Visibility: public export
year : Tm -> Int32
  Year since 1900

  Totality: total
  Visibility: public export
.wday : Tm -> Bits8
  Day of week (Sunday = 0)

  Totality: total
  Visibility: public export
wday : Tm -> Bits8
  Day of week (Sunday = 0)

  Totality: total
  Visibility: public export
.yday : Tm -> Bits16
  Day of year (0 - 365; 1 Jan = 0)

  Totality: total
  Visibility: public export
yday : Tm -> Bits16
  Day of year (0 - 365; 1 Jan = 0)

  Totality: total
  Visibility: public export
.isdst : Tm -> Bool
  `True` if daylight safing time is active

  Totality: total
  Visibility: public export
isdst : Tm -> Bool
  `True` if daylight safing time is active

  Totality: total
  Visibility: public export
blank : Tm
  A broken down time value with all fields set to zero (and `False`).
  
  Since `mday` - the day of the month - cannot be 0, it is set to 1 instead.

  Totality: total
  Visibility: export
epoch : Tm
  Unix Epoch (00:00:00 on Thursday 1 January 1970)

  Totality: total
  Visibility: export
tm : STm s -> F1 s Tm
  Totality: total
  Visibility: export
convTm : Convert Tm
  Totality: total
  Visibility: export
gmtime : TimeT -> Tm
  Converts time in seconds since the Epoch to broken down UTC time.

  Totality: total
  Visibility: export
localtime : TimeT -> Tm
  Converts time in seconds since the Epoch to broken down local time.

  Totality: total
  Visibility: export
fromUTC : Clock UTC -> Tm
  Converts a UTC clock value to broken down local time.

  Totality: total
  Visibility: export
asctime : Tm -> String
  Converts time to a nicely formatted string.

  Totality: total
  Visibility: export
mktime : Tm -> TimeT
  Converts a broken down time to seconds since the Epoch.

  Totality: total
  Visibility: export
toUTC : Tm -> Clock UTC
  Converts broken down local time to a UTC clock time.

  Totality: total
  Visibility: export
seconds : Tm -> Integer
  Keeps only the hours, seconds, and minutes of a broken down time.

  Totality: total
  Visibility: export
dateOnly : Tm -> Tm
  Drops the hours, seconds, and minutes from a broken down time.

  Totality: total
  Visibility: export