Z.IO.Environment

This module provide methods for retrieving various environment infomation. There's no encoding guarantee about these information, if you want textual representation, UTF8 assumption is recommended. i.e. use validate.

arguments

getArgs :: IO [CBytes]

Computation getArgs returns a list of the program's command line arguments (including the program path).

This is different from base's getArgs since result includes the program path(more like C's *argv).

environment variables

getAllEnv :: HasCallStack => IO [(CBytes, CBytes)]

Retrieves the environment variable.

Warning: This function is not thread safe.

getEnv :: HasCallStack => CBytes -> IO (Maybe CBytes)

Retrieves the environment variable specified by name.

Warning: This function is not thread safe.

getEnv' :: HasCallStack => CBytes -> IO CBytes

Retrieves the environment variable specified by name, throw NoSuchThing if not exists.

Warning: This function is not thread safe.

setEnv :: HasCallStack => CBytes -> CBytes -> IO ()

Creates or updates the environment variable specified by name with value.

Warning: This function is not thread safe.

unsetEnv :: HasCallStack => CBytes -> IO ()

Deletes the environment variable specified by name if such environment variable exists.

Warning: This function is not thread safe.

other environment infos

getCWD :: HasCallStack => IO CBytes

Gets the current working directory.

chDir :: HasCallStack => CBytes -> IO ()

Changes the current working directory.

getHomeDir :: HasCallStack => IO CBytes

Gets the current user’s home directory.

On Windows, first checks the USERPROFILE environment variable using GetEnvironmentVariableW(). If USERPROFILE is not set, GetUserProfileDirectoryW() is called. On all other operating systems, first checks the HOME environment variable using getenv(3). If HOME is not set, getpwuid_r(3) is called.

Warning getHomeDir is not thread safe.

getTempDir :: HasCallStack => IO CBytes

Gets the temp directory.

On Windows, uses GetTempPathW(). On all other operating systems, uses the first environment variable found in the ordered list TMPDIR, TMP, TEMP, and TEMPDIR. If none of these are found, the path /tmp is used, or, on Android, /data/local/tmp is used.

Warning getHomeDir is not thread safe.

getRandom :: Int -> IO Bytes

Fill buf with exactly buflen cryptographically strong random bytes acquired from the system CSPRNG.

The function may block indefinitely when not enough entropy is available, don't use it to get long random sequences.

getRandomT :: Int -> IO Bytes

Fill buf with exactly buflen cryptographically strong random bytes acquired from the system CSPRNG.

The function run getRandom in libuv's threadpool, suitable for get long random byte sequences.

getResUsage :: HasCallStack => IO ResUsage

Gets the resource usage measures for the current process.

On Windows not all fields are set, the unsupported fields are filled with zeroes. See ResUsage for more details.

data ResUsage

Data type for resource usage results.

Members marked with (X) are unsupported on Windows. See getrusage(2) for supported fields on Unix

Constructors

ResUsage

Fields

• ru_utime :: !TimeVal

  user CPU time used, in microseconds

• ru_stime :: !TimeVal

  system CPU time used, in microseconds

• ru_maxrss :: !Word64

  maximum resident set size

• ru_ixrss :: !Word64

  integral shared memory size (X)

• ru_idrss :: !Word64

  integral unshared data size (X)

• ru_isrss :: !Word64

  integral unshared stack size (X)

• ru_minflt :: !Word64

  page reclaims (soft page faults) (X)

• ru_majflt :: !Word64

  page faults (hard page faults)

• ru_nswap :: !Word64

  swaps (X)

• ru_inblock :: !Word64

  block input operations

• ru_oublock :: !Word64

  block output operations

• ru_msgsnd :: !Word64

  IPC messages sent (X)

• ru_msgrcv :: !Word64

  IPC messages received (X)

• ru_nsignals :: !Word64

  signals received (X)

• ru_nvcsw :: !Word64

  voluntary context switches (X)

• ru_nivcsw :: !Word64

  involuntary context switches (X)

Instances

Eq ResUsage

Defined in Z.IO.UV.FFI_Env

Methods

(==) :: ResUsage -> ResUsage -> Bool

(/=) :: ResUsage -> ResUsage -> Bool

Ord ResUsage

Defined in Z.IO.UV.FFI_Env

Methods

compare :: ResUsage -> ResUsage -> Ordering

(<) :: ResUsage -> ResUsage -> Bool

(<=) :: ResUsage -> ResUsage -> Bool

(>) :: ResUsage -> ResUsage -> Bool

(>=) :: ResUsage -> ResUsage -> Bool

max :: ResUsage -> ResUsage -> ResUsage

min :: ResUsage -> ResUsage -> ResUsage

Read ResUsage

Defined in Z.IO.UV.FFI_Env

Methods

readsPrec :: Int -> ReadS ResUsage

readList :: ReadS [ResUsage]

readPrec :: ReadPrec ResUsage

readListPrec :: ReadPrec [ResUsage]

Show ResUsage

Defined in Z.IO.UV.FFI_Env

Methods

showsPrec :: Int -> ResUsage -> ShowS

show :: ResUsage -> String

showList :: [ResUsage] -> ShowS

Generic ResUsage

Defined in Z.IO.UV.FFI_Env

Associated Types

type Rep ResUsage :: Type -> Type

Methods

from :: ResUsage -> Rep ResUsage x

to :: Rep ResUsage x -> ResUsage

JSON ResUsage

Defined in Z.IO.UV.FFI_Env

Methods

fromValue :: Value -> Converter ResUsage

toValue :: ResUsage -> Value

encodeJSON :: ResUsage -> Builder ()

Print ResUsage

Defined in Z.IO.UV.FFI_Env

Methods

toUTF8BuilderP :: Int -> ResUsage -> Builder ()

type Rep ResUsage

Defined in Z.IO.UV.FFI_Env

type Rep ResUsage = D1 ('MetaData "ResUsage" "Z.IO.UV.FFI_Env" "Z-IO-0.8.1.0-Dxm7r6yMY1QIBp9DYBXYzj" 'False) (C1 ('MetaCons "ResUsage" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "ru_utime") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 TimeVal) :*: S1 ('MetaSel ('Just "ru_stime") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 TimeVal)) :*: (S1 ('MetaSel ('Just "ru_maxrss") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "ru_ixrss") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64))) :*: ((S1 ('MetaSel ('Just "ru_idrss") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "ru_isrss") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :*: (S1 ('MetaSel ('Just "ru_minflt") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "ru_majflt") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64)))) :*: (((S1 ('MetaSel ('Just "ru_nswap") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "ru_inblock") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :*: (S1 ('MetaSel ('Just "ru_oublock") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "ru_msgsnd") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64))) :*: ((S1 ('MetaSel ('Just "ru_msgrcv") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "ru_nsignals") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :*: (S1 ('MetaSel ('Just "ru_nvcsw") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "ru_nivcsw") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64))))))

data TimeVal

Data type for storing times. typedef struct { long tv_sec; long tv_usec; } uv_timeval_t;

Constructors

TimeVal

Fields

• tv_sec :: !CLong
• tv_usec :: !CLong

Instances

Eq TimeVal

Defined in Z.IO.UV.FFI_Env

Methods

(==) :: TimeVal -> TimeVal -> Bool

(/=) :: TimeVal -> TimeVal -> Bool

Ord TimeVal

Defined in Z.IO.UV.FFI_Env

Methods

compare :: TimeVal -> TimeVal -> Ordering

(<) :: TimeVal -> TimeVal -> Bool

(<=) :: TimeVal -> TimeVal -> Bool

(>) :: TimeVal -> TimeVal -> Bool

(>=) :: TimeVal -> TimeVal -> Bool

max :: TimeVal -> TimeVal -> TimeVal

min :: TimeVal -> TimeVal -> TimeVal

Read TimeVal

Defined in Z.IO.UV.FFI_Env

Methods

readsPrec :: Int -> ReadS TimeVal

readList :: ReadS [TimeVal]

readPrec :: ReadPrec TimeVal

readListPrec :: ReadPrec [TimeVal]

Show TimeVal

Defined in Z.IO.UV.FFI_Env

Methods

showsPrec :: Int -> TimeVal -> ShowS

show :: TimeVal -> String

showList :: [TimeVal] -> ShowS

Generic TimeVal

Defined in Z.IO.UV.FFI_Env

Associated Types

type Rep TimeVal :: Type -> Type

Methods

from :: TimeVal -> Rep TimeVal x

to :: Rep TimeVal x -> TimeVal

JSON TimeVal

Defined in Z.IO.UV.FFI_Env

Methods

fromValue :: Value -> Converter TimeVal

toValue :: TimeVal -> Value

encodeJSON :: TimeVal -> Builder ()

Print TimeVal

Defined in Z.IO.UV.FFI_Env

Methods

toUTF8BuilderP :: Int -> TimeVal -> Builder ()

type Rep TimeVal

Defined in Z.IO.UV.FFI_Env

type Rep TimeVal = D1 ('MetaData "TimeVal" "Z.IO.UV.FFI_Env" "Z-IO-0.8.1.0-Dxm7r6yMY1QIBp9DYBXYzj" 'False) (C1 ('MetaCons "TimeVal" 'PrefixI 'True) (S1 ('MetaSel ('Just "tv_sec") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CLong) :*: S1 ('MetaSel ('Just "tv_usec") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CLong)))

getResidentSetMemory :: HasCallStack => IO CSize

Gets the resident set size (RSS) for the current process.

getUpTime :: HasCallStack => IO Double

Gets the current system uptime.

getHighResolutionTime :: IO Word64

Returns the current high-resolution real time.

This is expressed in nanoseconds. It is relative to an arbitrary time in the past. It is not related to the time of day and therefore not subject to clock drift. The primary use is for measuring performance between intervals.

newtype PID

Constructors

PID CInt

Instances

Eq PID

Defined in Z.IO.UV.FFI_Env

Methods

(==) :: PID -> PID -> Bool

(/=) :: PID -> PID -> Bool

Ord PID

Defined in Z.IO.UV.FFI_Env

Methods

compare :: PID -> PID -> Ordering

(<) :: PID -> PID -> Bool

(<=) :: PID -> PID -> Bool

(>) :: PID -> PID -> Bool

(>=) :: PID -> PID -> Bool

max :: PID -> PID -> PID

min :: PID -> PID -> PID

Read PID

Defined in Z.IO.UV.FFI_Env

Methods

readsPrec :: Int -> ReadS PID

readList :: ReadS [PID]

readPrec :: ReadPrec PID

readListPrec :: ReadPrec [PID]

Show PID

Defined in Z.IO.UV.FFI_Env

Methods

showsPrec :: Int -> PID -> ShowS

show :: PID -> String

showList :: [PID] -> ShowS

Generic PID

Defined in Z.IO.UV.FFI_Env

Associated Types

type Rep PID :: Type -> Type

Methods

from :: PID -> Rep PID x

to :: Rep PID x -> PID

JSON PID

Defined in Z.IO.UV.FFI_Env

Methods

fromValue :: Value -> Converter PID

toValue :: PID -> Value

encodeJSON :: PID -> Builder ()

Print PID

Defined in Z.IO.UV.FFI_Env

Methods

toUTF8BuilderP :: Int -> PID -> Builder ()

Unaligned PID

Defined in Z.IO.UV.FFI_Env

Methods

unalignedSize :: UnalignedSize PID

indexWord8ArrayAs# :: ByteArray# -> Int# -> PID

readWord8ArrayAs# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, PID #)

writeWord8ArrayAs# :: MutableByteArray# s -> Int# -> PID -> State# s -> State# s

peekMBA :: MutableByteArray# RealWorld -> Int -> IO PID

pokeMBA :: MutableByteArray# RealWorld -> Int -> PID -> IO ()

indexBA :: ByteArray# -> Int -> PID

Prim PID

Defined in Z.IO.UV.FFI_Env

Methods

sizeOf# :: PID -> Int#

alignment# :: PID -> Int#

indexByteArray# :: ByteArray# -> Int# -> PID

readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, PID #)

writeByteArray# :: MutableByteArray# s -> Int# -> PID -> State# s -> State# s

setByteArray# :: MutableByteArray# s -> Int# -> Int# -> PID -> State# s -> State# s

indexOffAddr# :: Addr# -> Int# -> PID

readOffAddr# :: Addr# -> Int# -> State# s -> (# State# s, PID #)

writeOffAddr# :: Addr# -> Int# -> PID -> State# s -> State# s

setOffAddr# :: Addr# -> Int# -> Int# -> PID -> State# s -> State# s

Storable PID

Defined in Z.IO.UV.FFI_Env

Methods

sizeOf :: PID -> Int

alignment :: PID -> Int

peekElemOff :: Ptr PID -> Int -> IO PID

pokeElemOff :: Ptr PID -> Int -> PID -> IO ()

peekByteOff :: Ptr b -> Int -> IO PID

pokeByteOff :: Ptr b -> Int -> PID -> IO ()

peek :: Ptr PID -> IO PID

poke :: Ptr PID -> PID -> IO ()

type Rep PID

Defined in Z.IO.UV.FFI_Env

type Rep PID = D1 ('MetaData "PID" "Z.IO.UV.FFI_Env" "Z-IO-0.8.1.0-Dxm7r6yMY1QIBp9DYBXYzj" 'True) (C1 ('MetaCons "PID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt)))

getPID :: IO PID

Returns the current process ID.

getPPID :: IO PID

Returns the parent process ID.

getHostname :: HasCallStack => IO CBytes

Returns the hostname as a null-terminated string.

getOSName :: HasCallStack => IO OSName

data OSName

Data type for operating system name and version information.

Constructors

OSName

Fields

• os_sysname :: CBytes
• os_release :: CBytes
• os_version :: CBytes
• os_machine :: CBytes

Instances

Eq OSName

Defined in Z.IO.UV.FFI_Env

Methods

(==) :: OSName -> OSName -> Bool

(/=) :: OSName -> OSName -> Bool

Ord OSName

Defined in Z.IO.UV.FFI_Env

Methods

compare :: OSName -> OSName -> Ordering

(<) :: OSName -> OSName -> Bool

(<=) :: OSName -> OSName -> Bool

(>) :: OSName -> OSName -> Bool

(>=) :: OSName -> OSName -> Bool

max :: OSName -> OSName -> OSName

min :: OSName -> OSName -> OSName

Read OSName

Defined in Z.IO.UV.FFI_Env

Methods

readsPrec :: Int -> ReadS OSName

readList :: ReadS [OSName]

readPrec :: ReadPrec OSName

readListPrec :: ReadPrec [OSName]

Show OSName

Defined in Z.IO.UV.FFI_Env

Methods

showsPrec :: Int -> OSName -> ShowS

show :: OSName -> String

showList :: [OSName] -> ShowS

Generic OSName

Defined in Z.IO.UV.FFI_Env

Associated Types

type Rep OSName :: Type -> Type

Methods

from :: OSName -> Rep OSName x

to :: Rep OSName x -> OSName

JSON OSName

Defined in Z.IO.UV.FFI_Env

Methods

fromValue :: Value -> Converter OSName

toValue :: OSName -> Value

encodeJSON :: OSName -> Builder ()

Print OSName

Defined in Z.IO.UV.FFI_Env

Methods

toUTF8BuilderP :: Int -> OSName -> Builder ()

type Rep OSName

Defined in Z.IO.UV.FFI_Env

type Rep OSName = D1 ('MetaData "OSName" "Z.IO.UV.FFI_Env" "Z-IO-0.8.1.0-Dxm7r6yMY1QIBp9DYBXYzj" 'False) (C1 ('MetaCons "OSName" 'PrefixI 'True) ((S1 ('MetaSel ('Just "os_sysname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :*: S1 ('MetaSel ('Just "os_release") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes)) :*: (S1 ('MetaSel ('Just "os_version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :*: S1 ('MetaSel ('Just "os_machine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes))))

getPassWD :: HasCallStack => IO PassWD

Gets a subset of the password file entry for the current effective uid (not the real uid).

The populated data includes the username, euid, gid, shell, and home directory. On non-Windows systems, all data comes from getpwuid_r(3). On Windows, uid and gid are set to -1 and have no meaning, and shell is empty.

data PassWD

Data type for password file information.

Constructors

PassWD

Fields

• passwd_username :: CBytes
• passwd_uid :: UID
• passwd_gid :: GID
• passwd_shell :: CBytes
• passwd_homedir :: CBytes

Instances

Eq PassWD

Defined in Z.IO.UV.FFI_Env

Methods

(==) :: PassWD -> PassWD -> Bool

(/=) :: PassWD -> PassWD -> Bool

Ord PassWD

Defined in Z.IO.UV.FFI_Env

Methods

compare :: PassWD -> PassWD -> Ordering

(<) :: PassWD -> PassWD -> Bool

(<=) :: PassWD -> PassWD -> Bool

(>) :: PassWD -> PassWD -> Bool

(>=) :: PassWD -> PassWD -> Bool

max :: PassWD -> PassWD -> PassWD

min :: PassWD -> PassWD -> PassWD

Read PassWD

Defined in Z.IO.UV.FFI_Env

Methods

readsPrec :: Int -> ReadS PassWD

readList :: ReadS [PassWD]

readPrec :: ReadPrec PassWD

readListPrec :: ReadPrec [PassWD]

Show PassWD

Defined in Z.IO.UV.FFI_Env

Methods

showsPrec :: Int -> PassWD -> ShowS

show :: PassWD -> String

showList :: [PassWD] -> ShowS

Generic PassWD

Defined in Z.IO.UV.FFI_Env

Associated Types

type Rep PassWD :: Type -> Type

Methods

from :: PassWD -> Rep PassWD x

to :: Rep PassWD x -> PassWD

JSON PassWD

Defined in Z.IO.UV.FFI_Env

Methods

fromValue :: Value -> Converter PassWD

toValue :: PassWD -> Value

encodeJSON :: PassWD -> Builder ()

Print PassWD

Defined in Z.IO.UV.FFI_Env

Methods

toUTF8BuilderP :: Int -> PassWD -> Builder ()

type Rep PassWD

Defined in Z.IO.UV.FFI_Env

type Rep PassWD = D1 ('MetaData "PassWD" "Z.IO.UV.FFI_Env" "Z-IO-0.8.1.0-Dxm7r6yMY1QIBp9DYBXYzj" 'False) (C1 ('MetaCons "PassWD" 'PrefixI 'True) ((S1 ('MetaSel ('Just "passwd_username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :*: S1 ('MetaSel ('Just "passwd_uid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UID)) :*: (S1 ('MetaSel ('Just "passwd_gid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GID) :*: (S1 ('MetaSel ('Just "passwd_shell") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :*: S1 ('MetaSel ('Just "passwd_homedir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes)))))

data UID

Instances

Eq UID

Defined in Z.IO.UV.FFI

Methods

(==) :: UID -> UID -> Bool

(/=) :: UID -> UID -> Bool

Num UID

Defined in Z.IO.UV.FFI

Methods

(+) :: UID -> UID -> UID

(-) :: UID -> UID -> UID

(*) :: UID -> UID -> UID

negate :: UID -> UID

abs :: UID -> UID

signum :: UID -> UID

fromInteger :: Integer -> UID

Ord UID

Defined in Z.IO.UV.FFI

Methods

compare :: UID -> UID -> Ordering

(<) :: UID -> UID -> Bool

(<=) :: UID -> UID -> Bool

(>) :: UID -> UID -> Bool

(>=) :: UID -> UID -> Bool

max :: UID -> UID -> UID

min :: UID -> UID -> UID

Read UID

Defined in Z.IO.UV.FFI

Methods

readsPrec :: Int -> ReadS UID

readList :: ReadS [UID]

readPrec :: ReadPrec UID

readListPrec :: ReadPrec [UID]

Show UID

Defined in Z.IO.UV.FFI

Methods

showsPrec :: Int -> UID -> ShowS

show :: UID -> String

showList :: [UID] -> ShowS

Generic UID

Defined in Z.IO.UV.FFI

Associated Types

type Rep UID :: Type -> Type

Methods

from :: UID -> Rep UID x

to :: Rep UID x -> UID

JSON UID

Defined in Z.IO.UV.FFI

Methods

fromValue :: Value -> Converter UID

toValue :: UID -> Value

encodeJSON :: UID -> Builder ()

Print UID

Defined in Z.IO.UV.FFI

Methods

toUTF8BuilderP :: Int -> UID -> Builder ()

Unaligned UID

Defined in Z.IO.UV.FFI

Methods

unalignedSize :: UnalignedSize UID

indexWord8ArrayAs# :: ByteArray# -> Int# -> UID

readWord8ArrayAs# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, UID #)

writeWord8ArrayAs# :: MutableByteArray# s -> Int# -> UID -> State# s -> State# s

peekMBA :: MutableByteArray# RealWorld -> Int -> IO UID

pokeMBA :: MutableByteArray# RealWorld -> Int -> UID -> IO ()

indexBA :: ByteArray# -> Int -> UID

Prim UID

Defined in Z.IO.UV.FFI

Methods

sizeOf# :: UID -> Int#

alignment# :: UID -> Int#

indexByteArray# :: ByteArray# -> Int# -> UID

readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, UID #)

writeByteArray# :: MutableByteArray# s -> Int# -> UID -> State# s -> State# s

setByteArray# :: MutableByteArray# s -> Int# -> Int# -> UID -> State# s -> State# s

indexOffAddr# :: Addr# -> Int# -> UID

readOffAddr# :: Addr# -> Int# -> State# s -> (# State# s, UID #)

writeOffAddr# :: Addr# -> Int# -> UID -> State# s -> State# s

setOffAddr# :: Addr# -> Int# -> Int# -> UID -> State# s -> State# s

Storable UID

Defined in Z.IO.UV.FFI

Methods

sizeOf :: UID -> Int

alignment :: UID -> Int

peekElemOff :: Ptr UID -> Int -> IO UID

pokeElemOff :: Ptr UID -> Int -> UID -> IO ()

peekByteOff :: Ptr b -> Int -> IO UID

pokeByteOff :: Ptr b -> Int -> UID -> IO ()

peek :: Ptr UID -> IO UID

poke :: Ptr UID -> UID -> IO ()

type Rep UID

Defined in Z.IO.UV.FFI

type Rep UID = D1 ('MetaData "UID" "Z.IO.UV.FFI" "Z-IO-0.8.1.0-Dxm7r6yMY1QIBp9DYBXYzj" 'True) (C1 ('MetaCons "UID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

data GID

Instances

Eq GID

Defined in Z.IO.UV.FFI

Methods

(==) :: GID -> GID -> Bool

(/=) :: GID -> GID -> Bool

Num GID

Defined in Z.IO.UV.FFI

Methods

(+) :: GID -> GID -> GID

(-) :: GID -> GID -> GID

(*) :: GID -> GID -> GID

negate :: GID -> GID

abs :: GID -> GID

signum :: GID -> GID

fromInteger :: Integer -> GID

Ord GID

Defined in Z.IO.UV.FFI

Methods

compare :: GID -> GID -> Ordering

(<) :: GID -> GID -> Bool

(<=) :: GID -> GID -> Bool

(>) :: GID -> GID -> Bool

(>=) :: GID -> GID -> Bool

max :: GID -> GID -> GID

min :: GID -> GID -> GID

Read GID

Defined in Z.IO.UV.FFI

Methods

readsPrec :: Int -> ReadS GID

readList :: ReadS [GID]

readPrec :: ReadPrec GID

readListPrec :: ReadPrec [GID]

Show GID

Defined in Z.IO.UV.FFI

Methods

showsPrec :: Int -> GID -> ShowS

show :: GID -> String

showList :: [GID] -> ShowS

Generic GID

Defined in Z.IO.UV.FFI

Associated Types

type Rep GID :: Type -> Type

Methods

from :: GID -> Rep GID x

to :: Rep GID x -> GID

JSON GID

Defined in Z.IO.UV.FFI

Methods

fromValue :: Value -> Converter GID

toValue :: GID -> Value

encodeJSON :: GID -> Builder ()

Print GID

Defined in Z.IO.UV.FFI

Methods

toUTF8BuilderP :: Int -> GID -> Builder ()

Unaligned GID

Defined in Z.IO.UV.FFI

Methods

unalignedSize :: UnalignedSize GID

indexWord8ArrayAs# :: ByteArray# -> Int# -> GID

readWord8ArrayAs# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, GID #)

writeWord8ArrayAs# :: MutableByteArray# s -> Int# -> GID -> State# s -> State# s

peekMBA :: MutableByteArray# RealWorld -> Int -> IO GID

pokeMBA :: MutableByteArray# RealWorld -> Int -> GID -> IO ()

indexBA :: ByteArray# -> Int -> GID

Prim GID

Defined in Z.IO.UV.FFI

Methods

sizeOf# :: GID -> Int#

alignment# :: GID -> Int#

indexByteArray# :: ByteArray# -> Int# -> GID

readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, GID #)

writeByteArray# :: MutableByteArray# s -> Int# -> GID -> State# s -> State# s

setByteArray# :: MutableByteArray# s -> Int# -> Int# -> GID -> State# s -> State# s

indexOffAddr# :: Addr# -> Int# -> GID

readOffAddr# :: Addr# -> Int# -> State# s -> (# State# s, GID #)

writeOffAddr# :: Addr# -> Int# -> GID -> State# s -> State# s

setOffAddr# :: Addr# -> Int# -> Int# -> GID -> State# s -> State# s

Storable GID

Defined in Z.IO.UV.FFI

Methods

sizeOf :: GID -> Int

alignment :: GID -> Int

peekElemOff :: Ptr GID -> Int -> IO GID

pokeElemOff :: Ptr GID -> Int -> GID -> IO ()

peekByteOff :: Ptr b -> Int -> IO GID

pokeByteOff :: Ptr b -> Int -> GID -> IO ()

peek :: Ptr GID -> IO GID

poke :: Ptr GID -> GID -> IO ()

type Rep GID

Defined in Z.IO.UV.FFI

type Rep GID = D1 ('MetaData "GID" "Z.IO.UV.FFI" "Z-IO-0.8.1.0-Dxm7r6yMY1QIBp9DYBXYzj" 'True) (C1 ('MetaCons "GID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

getCPUInfo :: HasCallStack => IO [CPUInfo]

Gets information about the CPUs on the system.

data CPUInfo

Data type for CPU information.

Constructors

CPUInfo

Fields

• cpu_model :: CBytes
• cpu_speed :: CInt
• cpu_times_user :: Word64

  milliseconds

• cpu_times_nice :: Word64

  milliseconds

• cpu_times_sys :: Word64

  milliseconds

• cpu_times_idle :: Word64

  milliseconds

• cpu_times_irq :: Word64

  milliseconds

Instances

Eq CPUInfo

Defined in Z.IO.UV.FFI_Env

Methods

(==) :: CPUInfo -> CPUInfo -> Bool

(/=) :: CPUInfo -> CPUInfo -> Bool

Ord CPUInfo

Defined in Z.IO.UV.FFI_Env

Methods

compare :: CPUInfo -> CPUInfo -> Ordering

(<) :: CPUInfo -> CPUInfo -> Bool

(<=) :: CPUInfo -> CPUInfo -> Bool

(>) :: CPUInfo -> CPUInfo -> Bool

(>=) :: CPUInfo -> CPUInfo -> Bool

max :: CPUInfo -> CPUInfo -> CPUInfo

min :: CPUInfo -> CPUInfo -> CPUInfo

Read CPUInfo

Defined in Z.IO.UV.FFI_Env

Methods

readsPrec :: Int -> ReadS CPUInfo

readList :: ReadS [CPUInfo]

readPrec :: ReadPrec CPUInfo

readListPrec :: ReadPrec [CPUInfo]

Show CPUInfo

Defined in Z.IO.UV.FFI_Env

Methods

showsPrec :: Int -> CPUInfo -> ShowS

show :: CPUInfo -> String

showList :: [CPUInfo] -> ShowS

Generic CPUInfo

Defined in Z.IO.UV.FFI_Env

Associated Types

type Rep CPUInfo :: Type -> Type

Methods

from :: CPUInfo -> Rep CPUInfo x

to :: Rep CPUInfo x -> CPUInfo

JSON CPUInfo

Defined in Z.IO.UV.FFI_Env

Methods

fromValue :: Value -> Converter CPUInfo

toValue :: CPUInfo -> Value

encodeJSON :: CPUInfo -> Builder ()

Print CPUInfo

Defined in Z.IO.UV.FFI_Env

Methods

toUTF8BuilderP :: Int -> CPUInfo -> Builder ()

type Rep CPUInfo

Defined in Z.IO.UV.FFI_Env

type Rep CPUInfo = D1 ('MetaData "CPUInfo" "Z.IO.UV.FFI_Env" "Z-IO-0.8.1.0-Dxm7r6yMY1QIBp9DYBXYzj" 'False) (C1 ('MetaCons "CPUInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cpu_model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :*: (S1 ('MetaSel ('Just "cpu_speed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt) :*: S1 ('MetaSel ('Just "cpu_times_user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64))) :*: ((S1 ('MetaSel ('Just "cpu_times_nice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64) :*: S1 ('MetaSel ('Just "cpu_times_sys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)) :*: (S1 ('MetaSel ('Just "cpu_times_idle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64) :*: S1 ('MetaSel ('Just "cpu_times_irq") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))))

getLoadAvg :: IO (Double, Double, Double)

Gets the load average. See: https://en.wikipedia.org/wiki/Load_(computing)

getFreeMem :: IO Word64

Gets the amount of free memory available in the system, as reported by the kernel (in bytes).

getTotalMem :: IO Word64

Gets the total amount of physical memory in the system (in bytes).

getConstrainedMem :: IO Word64

Gets the amount of memory available to the process (in bytes) based on limits imposed by the OS.

If there is no such constraint, or the constraint is unknown, 0 is returned. Note that it is not unusual for this value to be less than or greater than getTotalMem. Note This function currently only returns a non-zero value on Linux, based on cgroups if it is present.