shrun-0.9: A utility program for running shell commands concurrently.
Safe HaskellNone
LanguageGHC2021

Shrun.IO.Types

Description

Provides types for typical IO processes.

Synopsis

Documentation

newtype Stderr Source #

Newtype wrapper for stderr.

Constructors

MkStderr 

Fields

Instances

Instances details
Show Stderr Source # 
Instance details

Defined in Shrun.IO.Types

Methods

showsPrec :: Int -> Stderr -> ShowS #

show :: Stderr -> String #

showList :: [Stderr] -> ShowS #

Eq Stderr Source # 
Instance details

Defined in Shrun.IO.Types

Methods

(==) :: Stderr -> Stderr -> Bool #

(/=) :: Stderr -> Stderr -> Bool #

data CommandResult Source #

Result of running a command.

Constructors

CommandSuccess RelativeTime 
CommandFailure RelativeTime Stderr 

Instances

Instances details
Show CommandResult Source # 
Instance details

Defined in Shrun.IO.Types

Methods

showsPrec :: Int -> CommandResult -> ShowS #

show :: CommandResult -> String #

showList :: [CommandResult] -> ShowS #

Eq CommandResult Source # 
Instance details

Defined in Shrun.IO.Types

Methods

(==) :: CommandResult -> CommandResult -> Bool #

(/=) :: CommandResult -> CommandResult -> Bool #

data ReadHandleResult Source #

Result from reading a handle. The ordering is based on:

ReadErr _ < ReadNoData < ReadSuccess

The Semigroup instance is based on this ordering, taking the greatest element. For identical constructors, the left argument is taken.

Constructors

ReadErr (List UnlinedText)

Error encountered while trying to read a handle.

ReadSuccess (List UnlinedText)

Successfully read data from the handle.

ReadNoData

Successfully read no data from the handle.

Instances

Instances details
Monoid ReadHandleResult Source # 
Instance details

Defined in Shrun.IO.Types

Methods

mempty :: ReadHandleResult #

mappend :: ReadHandleResult -> ReadHandleResult -> ReadHandleResult #

mconcat :: [ReadHandleResult] -> ReadHandleResult #

Semigroup ReadHandleResult Source # 
Instance details

Defined in Shrun.IO.Types

Methods

(<>) :: ReadHandleResult -> ReadHandleResult -> ReadHandleResult #

sconcat :: NonEmpty ReadHandleResult -> ReadHandleResult #

stimes :: Integral b => b -> ReadHandleResult -> ReadHandleResult #

Show ReadHandleResult Source # 
Instance details

Defined in Shrun.IO.Types

Methods

showsPrec :: Int -> ReadHandleResult -> ShowS #

show :: ReadHandleResult -> String #

showList :: [ReadHandleResult] -> ShowS #

Eq ReadHandleResult Source # 
Instance details

Defined in Shrun.IO.Types

Methods

(==) :: ReadHandleResult -> ReadHandleResult -> Bool #

(/=) :: ReadHandleResult -> ReadHandleResult -> Bool #

readHandleResultToStderr :: ReadHandleResult -> Stderr Source #

Turns a ReadHandleResult into a Stderr.

readHandle :: (HasCallStack, MonadCatch m, MonadHandleReader m) => Int -> Handle -> m ReadHandleResult Source #

Attempts to read from the handle.