Zifter.Zift.Types

Documentation

data ZiftOutput

Constructors

ZiftOutput

Fields

• outputColors :: [SGR]
• outputMessage :: String

Instances

Eq ZiftOutput

Methods

(==) :: ZiftOutput -> ZiftOutput -> Bool

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

Show ZiftOutput

Methods

showsPrec :: Int -> ZiftOutput -> ShowS

show :: ZiftOutput -> String

showList :: [ZiftOutput] -> ShowS

Generic ZiftOutput

Associated Types

type Rep ZiftOutput :: * -> *

Methods

from :: ZiftOutput -> Rep ZiftOutput x

to :: Rep ZiftOutput x -> ZiftOutput

type Rep ZiftOutput

type Rep ZiftOutput = D1 * (MetaData "ZiftOutput" "Zifter.Zift.Types" "zifter-0.0.1.4-1pfWuwSPjO7GIdotoq9LHy" False) (C1 * (MetaCons "ZiftOutput" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "outputColors") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [SGR])) (S1 * (MetaSel (Just Symbol "outputMessage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String))))

data ZiftContext

Constructors

ZiftContext

Fields

• rootdir :: Path Abs Dir
• tmpdir :: Path Abs Dir
• settings :: Settings
• printChan :: TChan ZiftOutput
• recursionList :: [LMR]

Instances

Generic ZiftContext

Associated Types

type Rep ZiftContext :: * -> *

Methods

from :: ZiftContext -> Rep ZiftContext x

to :: Rep ZiftContext x -> ZiftContext

Validity ZiftContext

Methods

validate :: ZiftContext -> Validation

isValid :: ZiftContext -> Bool

type Rep ZiftContext

type Rep ZiftContext = D1 * (MetaData "ZiftContext" "Zifter.Zift.Types" "zifter-0.0.1.4-1pfWuwSPjO7GIdotoq9LHy" False) (C1 * (MetaCons "ZiftContext" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "rootdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Path Abs Dir))) (S1 * (MetaSel (Just Symbol "tmpdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Path Abs Dir)))) ((:*:) * (S1 * (MetaSel (Just Symbol "settings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Settings)) ((:*:) * (S1 * (MetaSel (Just Symbol "printChan") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (TChan ZiftOutput))) (S1 * (MetaSel (Just Symbol "recursionList") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [LMR]))))))

data LMR

Constructors

L

M

R

Instances

Eq LMR

Methods

(==) :: LMR -> LMR -> Bool

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

Show LMR

Methods

showsPrec :: Int -> LMR -> ShowS

show :: LMR -> String

showList :: [LMR] -> ShowS

Generic LMR

Associated Types

type Rep LMR :: * -> *

Methods

from :: LMR -> Rep LMR x

to :: Rep LMR x -> LMR

type Rep LMR

type Rep LMR = D1 * (MetaData "LMR" "Zifter.Zift.Types" "zifter-0.0.1.4-1pfWuwSPjO7GIdotoq9LHy" False) ((:+:) * (C1 * (MetaCons "L" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "M" PrefixI False) (U1 *)) (C1 * (MetaCons "R" PrefixI False) (U1 *))))

newtype ZiftState

Constructors

ZiftState

Fields

• bufferedOutput :: [ZiftOutput]

Instances

Eq ZiftState

Methods

(==) :: ZiftState -> ZiftState -> Bool

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

Show ZiftState

Methods

showsPrec :: Int -> ZiftState -> ShowS

show :: ZiftState -> String

showList :: [ZiftState] -> ShowS

Generic ZiftState

Associated Types

type Rep ZiftState :: * -> *

Methods

from :: ZiftState -> Rep ZiftState x

to :: Rep ZiftState x -> ZiftState

Monoid ZiftState

Methods

mempty :: ZiftState

mappend :: ZiftState -> ZiftState -> ZiftState

mconcat :: [ZiftState] -> ZiftState

type Rep ZiftState

type Rep ZiftState = D1 * (MetaData "ZiftState" "Zifter.Zift.Types" "zifter-0.0.1.4-1pfWuwSPjO7GIdotoq9LHy" True) (C1 * (MetaCons "ZiftState" PrefixI True) (S1 * (MetaSel (Just Symbol "bufferedOutput") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [ZiftOutput])))

newtype Zift a

Constructors

Zift

Fields

• zift :: ZiftContext -> ZiftState -> IO (ZiftResult a, ZiftState)

Instances

Monad Zift

Zift actions can be composed.

Methods

(>>=) :: Zift a -> (a -> Zift b) -> Zift b

(>>) :: Zift a -> Zift b -> Zift b

return :: a -> Zift a

fail :: String -> Zift a

Functor Zift

Methods

fmap :: (a -> b) -> Zift a -> Zift b

(<$) :: a -> Zift b -> Zift a

MonadFail Zift

A Zift action can fail.

To make a Zift action fail, you can use the fail :: String -> Zift a function.

The implementation uses the given string as the message that is shown at the very end of the run.

Methods

fail :: String -> Zift a

Applicative Zift

Zift actions can be sequenced.

The implementation automatically parallelises the arguments of the (*) function. If any of the actions fails, the other is cancelled and the result fails.

Methods

pure :: a -> Zift a

(<*>) :: Zift (a -> b) -> Zift a -> Zift b

liftA2 :: (a -> b -> c) -> Zift a -> Zift b -> Zift c

(*>) :: Zift a -> Zift b -> Zift b

(<*) :: Zift a -> Zift b -> Zift a

MonadIO Zift

Any IO action can be part of a Zift action.

This is the most important instance for the end user.

liftIO :: IO a -> Zift a

allows embedding arbitrary IO actions inside a Zift action.

The implementation also ensures that exceptions are caught.

Methods

liftIO :: IO a -> Zift a

MonadThrow Zift

Methods

throwM :: Exception e => e -> Zift a

Generic (Zift a)

Associated Types

type Rep (Zift a) :: * -> *

Methods

from :: Zift a -> Rep (Zift a) x

to :: Rep (Zift a) x -> Zift a

Monoid a => Monoid (Zift a)

Methods

mempty :: Zift a

mappend :: Zift a -> Zift a -> Zift a

mconcat :: [Zift a] -> Zift a

type Rep (Zift a)

type Rep (Zift a) = D1 * (MetaData "Zift" "Zifter.Zift.Types" "zifter-0.0.1.4-1pfWuwSPjO7GIdotoq9LHy" True) (C1 * (MetaCons "Zift" PrefixI True) (S1 * (MetaSel (Just Symbol "zift") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (ZiftContext -> ZiftState -> IO (ZiftResult a, ZiftState)))))

data ZiftResult a

Constructors

ZiftSuccess a

ZiftFailed String

Instances

Monad ZiftResult

Methods

(>>=) :: ZiftResult a -> (a -> ZiftResult b) -> ZiftResult b

(>>) :: ZiftResult a -> ZiftResult b -> ZiftResult b

return :: a -> ZiftResult a

fail :: String -> ZiftResult a

Functor ZiftResult

Methods

fmap :: (a -> b) -> ZiftResult a -> ZiftResult b

(<$) :: a -> ZiftResult b -> ZiftResult a

MonadFail ZiftResult

Methods

fail :: String -> ZiftResult a

Applicative ZiftResult

Methods

pure :: a -> ZiftResult a

(<*>) :: ZiftResult (a -> b) -> ZiftResult a -> ZiftResult b

liftA2 :: (a -> b -> c) -> ZiftResult a -> ZiftResult b -> ZiftResult c

(*>) :: ZiftResult a -> ZiftResult b -> ZiftResult b

(<*) :: ZiftResult a -> ZiftResult b -> ZiftResult a

Eq a => Eq (ZiftResult a)

Methods

(==) :: ZiftResult a -> ZiftResult a -> Bool

(/=) :: ZiftResult a -> ZiftResult a -> Bool

Show a => Show (ZiftResult a)

Methods

showsPrec :: Int -> ZiftResult a -> ShowS

show :: ZiftResult a -> String

showList :: [ZiftResult a] -> ShowS

Generic (ZiftResult a)

Associated Types

type Rep (ZiftResult a) :: * -> *

Methods

from :: ZiftResult a -> Rep (ZiftResult a) x

to :: Rep (ZiftResult a) x -> ZiftResult a

Monoid a => Monoid (ZiftResult a)

Methods

mempty :: ZiftResult a

mappend :: ZiftResult a -> ZiftResult a -> ZiftResult a

mconcat :: [ZiftResult a] -> ZiftResult a

Validity a => Validity (ZiftResult a)

Methods

validate :: ZiftResult a -> Validation

isValid :: ZiftResult a -> Bool

type Rep (ZiftResult a)

type Rep (ZiftResult a) = D1 * (MetaData "ZiftResult" "Zifter.Zift.Types" "zifter-0.0.1.4-1pfWuwSPjO7GIdotoq9LHy" False) ((:+:) * (C1 * (MetaCons "ZiftSuccess" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * a))) (C1 * (MetaCons "ZiftFailed" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String))))

tryFlushZiftBuffer :: ZiftContext -> ZiftState -> IO ZiftState

Internal: do not use yourself.

flushable :: [LMR] -> Bool