Control.Teardown

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

Documentation

class ITeardown d where

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

Minimal complete definition

teardown

Methods

teardown :: d -> IO TeardownResult

Executes teardown sub-routine returning a TeardownResult

Instances

ITeardown Teardown

Methods

teardown :: Teardown -> IO TeardownResult

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

ITeardown Teardown

Methods

teardown :: Teardown -> IO TeardownResult

type Rep Teardown

type Rep Teardown = D1 (MetaData "Teardown" "Control.Teardown.Internal.Core" "teardown-0.0.0.2-CP23rXs1PrmGbF5PqQjcsX" True) (C1 (MetaCons "Teardown" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (IO TeardownResult))))

teardown :: ITeardown d => d -> IO TeardownResult

Executes teardown sub-routine returning a TeardownResult

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 :: Description -> IO () -> IO Teardown

Creates a new Teardown sub-routine from a cleanup IO action, the side-effects from this action are guaranteed to be executed only once, and also it is guaranteed to be thread-safe in the scenario of multiple threads executing the same teardown procedure.

newDynTeardown :: Description -> IO [TeardownResult] -> Teardown

Creates a Teardown sub-routine that is composed of inner sub-routines that are allocated at runtime. This is useful if allocations are being created and being hold on a Mutable variable of some sort (e.g. IORef, TVar, etc) so that on cleanup this Mutable variable is read and the results of the teardown operation are returned.

concatTeardown :: Description -> [Teardown] -> Teardown

Creates a Teardown sub-routine that is composed of other smaller sub-routines. This is ideal for composing the cleanup of an application from smaller resources allocations that are known at compilation time.

Functions to deal with results from teardown call

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

type Rep TeardownResult

type Rep TeardownResult

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

renderTeardownReport :: TeardownResult -> Doc

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