Control.Teardown

Provides functions that help on the creation of Application teardown sub-routines

Typeclasses for extending teardown functionality

class HasTeardown teardown where

A record that is or contains a Teardown sub-routine should instantiate this typeclass

Minimal complete definition

getTeardown

Methods

getTeardown :: teardown -> Teardown

Executes teardown sub-routine returning a TeardownResult

class IResource resource where

A resource or sub-routine that can be transformed into a Teardown operation

Minimal complete definition

newTeardown

Methods

newTeardown :: Text -> resource -> IO Teardown

Cleanup main type and function

data Teardown

Sub-routine that performs a resource cleanup operation

Instances

Generic Teardown

Associated Types

type Rep Teardown :: * -> *

Methods

from :: Teardown -> Rep Teardown x

to :: Rep Teardown x -> Teardown

NFData Teardown

Methods

rnf :: Teardown -> ()

type Rep Teardown

type Rep Teardown = D1 * (MetaData "Teardown" "Control.Teardown.Internal.Types" "teardown-0.4.0.0-5G5sxvEa6ofCsEgKw8QJjk" True) (C1 * (MetaCons "Teardown" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (IO TeardownResult))))

data TeardownResult

Result from a Teardown sub-routine

Constructors

BranchResult

Result is composed by multiple teardown sub-routines

Fields

• resultDescription :: !Description

  Text description of parent teardown spec

• resultElapsedTime :: !NominalDiffTime

  Sum of elapsed time on sub-routines execution

• resultDidFail :: !Bool

  Tells if any sub-routines failed

• resultListing :: ![TeardownResult]

  Results of inner sub-routines

LeafResult

Result represents a single teardown sub-routine

Fields

• resultDescription :: !Description

  Text description of parent teardown spec

• resultElapsedTime :: !NominalDiffTime

  Sum of elapsed time on sub-routines execution

• resultError :: !(Maybe SomeException)

  Exception from sub-routine

EmptyResult

Represents a stub cleanup operation (for lifting pure values)

Fields

• resultDescription :: !Description

  Text description of parent teardown spec

Instances

Show TeardownResult

Methods

showsPrec :: Int -> TeardownResult -> ShowS

show :: TeardownResult -> String

showList :: [TeardownResult] -> ShowS

Generic TeardownResult

Associated Types

type Rep TeardownResult :: * -> *

Methods

from :: TeardownResult -> Rep TeardownResult x

to :: Rep TeardownResult x -> TeardownResult

NFData TeardownResult

Methods

rnf :: TeardownResult -> ()

type Rep TeardownResult

type Rep TeardownResult

runTeardown :: HasTeardown t => t -> IO TeardownResult

Executes all composed Teardown sub-routines safely, and returns a Tree data structure wich can be used to gather facts from the cleanup process.

runTeardown_ :: HasTeardown t => t -> IO ()

Executes all composed Teardown sub-routines safely.

Functions to create a Teardown record

emptyTeardown :: Description -> Teardown

Creates a stub Teardown sub-routine, normally used when a contract expects a teardown return but there is no allocation being made

newTeardown :: IResource resource => Text -> resource -> IO Teardown

Functions to deal with results from teardown call

didTeardownFail :: TeardownResult -> Bool

Returns a boolean indicating if any of the cleanup sub-routine failed

failedToredownCount :: TeardownResult -> Int

Returns number of sub-routines that threw an exception on execution of teardown

toredownCount :: TeardownResult -> Int

Returns number of sub-routines executed at teardown

prettyTeardownResult :: TeardownResult -> Doc

Renders an ASCII Tree with the TeardownResult of a Teardown sub-routine execution