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, use UTF8 assumption is recommended. i.e. use "Z.Data.Text.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

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.5.2-E8snmgiQshiGGBBWzHXGeM" 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 :: Text
• os_release :: Text
• os_version :: Text
• os_machine :: Text

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.5.2-E8snmgiQshiGGBBWzHXGeM" False) (C1 (MetaCons "OSName" PrefixI True) ((S1 (MetaSel (Just "os_sysname") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "os_release") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :*: (S1 (MetaSel (Just "os_version") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "os_machine") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))

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.