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.

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.

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

Methods

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

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

Ord PID

Defined in Z.IO.UV.FFI

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

Show PID

Defined in Z.IO.UV.FFI

Methods

showsPrec :: Int -> PID -> ShowS

show :: PID -> String

showList :: [PID] -> ShowS

Generic PID

Defined in Z.IO.UV.FFI

Associated Types

type Rep PID :: Type -> Type

Methods

from :: PID -> Rep PID x

to :: Rep PID x -> PID

ToValue PID

Defined in Z.IO.UV.FFI

Methods

toValue :: PID -> Value

EncodeJSON PID

Defined in Z.IO.UV.FFI

Methods

encodeJSON :: PID -> Builder ()

FromValue PID

Defined in Z.IO.UV.FFI

Methods

fromValue :: Value -> Converter PID

ShowT PID

Defined in Z.IO.UV.FFI

Methods

toTextBuilder :: Int -> PID -> TextBuilder ()

Unaligned PID

Defined in Z.IO.UV.FFI

Methods

unalignedSize :: PID -> Int

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

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

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

type Rep PID = D1 (MetaData "PID" "Z.IO.UV.FFI" "Z-IO-0.1.6.0-GaocTtZII6UDtCkzE4xnxb" 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 :: IO OSName

data OSName

Constructors

OSName

Fields

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

Instances

Eq OSName

Defined in Z.IO.UV.FFI

Methods

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

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

Ord OSName

Defined in Z.IO.UV.FFI

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

Show OSName

Defined in Z.IO.UV.FFI

Methods

showsPrec :: Int -> OSName -> ShowS

show :: OSName -> String

showList :: [OSName] -> ShowS

Generic OSName

Defined in Z.IO.UV.FFI

Associated Types

type Rep OSName :: Type -> Type

Methods

from :: OSName -> Rep OSName x

to :: Rep OSName x -> OSName

ToValue OSName

Defined in Z.IO.UV.FFI

Methods

toValue :: OSName -> Value

EncodeJSON OSName

Defined in Z.IO.UV.FFI

Methods

encodeJSON :: OSName -> Builder ()

FromValue OSName

Defined in Z.IO.UV.FFI

Methods

fromValue :: Value -> Converter OSName

ShowT OSName

Defined in Z.IO.UV.FFI

Methods

toTextBuilder :: Int -> OSName -> TextBuilder ()

type Rep OSName

Defined in Z.IO.UV.FFI

type Rep OSName = D1 (MetaData "OSName" "Z.IO.UV.FFI" "Z-IO-0.1.6.0-GaocTtZII6UDtCkzE4xnxb" 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 :: 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

Methods

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

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

Ord PassWD

Defined in Z.IO.UV.FFI

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

Show PassWD

Defined in Z.IO.UV.FFI

Methods

showsPrec :: Int -> PassWD -> ShowS

show :: PassWD -> String

showList :: [PassWD] -> ShowS

Generic PassWD

Defined in Z.IO.UV.FFI

Associated Types

type Rep PassWD :: Type -> Type

Methods

from :: PassWD -> Rep PassWD x

to :: Rep PassWD x -> PassWD

ToValue PassWD

Defined in Z.IO.UV.FFI

Methods

toValue :: PassWD -> Value

EncodeJSON PassWD

Defined in Z.IO.UV.FFI

Methods

encodeJSON :: PassWD -> Builder ()

FromValue PassWD

Defined in Z.IO.UV.FFI

Methods

fromValue :: Value -> Converter PassWD

ShowT PassWD

Defined in Z.IO.UV.FFI

Methods

toTextBuilder :: Int -> PassWD -> TextBuilder ()

type Rep PassWD

Defined in Z.IO.UV.FFI

type Rep PassWD = D1 (MetaData "PassWD" "Z.IO.UV.FFI" "Z-IO-0.1.6.0-GaocTtZII6UDtCkzE4xnxb" 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

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

ToValue UID

Defined in Z.IO.UV.FFI

Methods

toValue :: UID -> Value

EncodeJSON UID

Defined in Z.IO.UV.FFI

Methods

encodeJSON :: UID -> Builder ()

FromValue UID

Defined in Z.IO.UV.FFI

Methods

fromValue :: Value -> Converter UID

ShowT UID

Defined in Z.IO.UV.FFI

Methods

toTextBuilder :: Int -> UID -> TextBuilder ()

Unaligned UID

Defined in Z.IO.UV.FFI

Methods

unalignedSize :: UID -> Int

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.1.6.0-GaocTtZII6UDtCkzE4xnxb" 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

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

ToValue GID

Defined in Z.IO.UV.FFI

Methods

toValue :: GID -> Value

EncodeJSON GID

Defined in Z.IO.UV.FFI

Methods

encodeJSON :: GID -> Builder ()

FromValue GID

Defined in Z.IO.UV.FFI

Methods

fromValue :: Value -> Converter GID

ShowT GID

Defined in Z.IO.UV.FFI

Methods

toTextBuilder :: Int -> GID -> TextBuilder ()

Unaligned GID

Defined in Z.IO.UV.FFI

Methods

unalignedSize :: GID -> Int

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.1.6.0-GaocTtZII6UDtCkzE4xnxb" True) (C1 (MetaCons "GID" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word32)))

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.