Safe Haskell	None
Language	Haskell2010

Control.Monad.Component.Internal.Types

Synopsis

data ComponentError
- = ComponentRuntimeFailed {
  - componentErrorOriginalException :: !SomeException
  - componentErrorTeardownResult :: !TeardownResult
  }
- | ComponentBuildFailed {
  - componentErrorBuildErrors :: ![ComponentBuildError]
  - componentErrorTeardownResult :: !TeardownResult
  }
data ComponentBuildError
- = DuplicatedComponentKeyDetected !Description
- | ComponentAllocationFailed !Description !SomeException
- | ComponentErrorThrown !SomeException
- | ComponentIOLiftFailed !SomeException
newtype ComponentM a = ComponentM (IO (Either ([ComponentBuildError], BuildTable) (a, BuildTable)))
data Build = Build {
- componentDesc :: !Description
- componentTeardown :: !Teardown
- buildElapsedTime :: !NominalDiffTime
- buildFailure :: !(Maybe SomeException)
- buildDependencies :: !(Set Description)
}
newtype BuildResult = BuildResult {
- toBuildList :: [Build]
}
data TeardownResult
data ComponentEvent
buildTableToOrderedList :: BuildTable -> [Build]
buildTableToTeardown :: Text -> BuildTable -> IO Teardown

Documentation

data ComponentError #

Exception thrown by the runComponentM family of functions

Constructors

ComponentRuntimeFailed	Failure raised when the Application Callback given to a `runComponentM` function throws an exception
Fields componentErrorOriginalException :: !SomeException Exception that was originally thrown by the Application Callback componentErrorTeardownResult :: !TeardownResult Result from the execution allocated resources teardown
ComponentBuildFailed	Failure raised when execution of `ComponentM` throws an exception
Fields componentErrorBuildErrors :: ![ComponentBuildError] Exceptions thrown by `IO` sub-routines used when constructing `ComponentM` values (e.g. `buildComponent`) componentErrorTeardownResult :: !TeardownResult Result from the execution allocated resources teardown

Instances

Show ComponentError #
Instance details Defined in Control.Monad.Component.Internal.Types Methods showsPrec :: Int -> ComponentError -> ShowS # show :: ComponentError -> String # showList :: [ComponentError] -> ShowS #
Generic ComponentError #
Instance details Defined in Control.Monad.Component.Internal.Types Associated Types type Rep ComponentError :: * -> * # Methods from :: ComponentError -> Rep ComponentError x # to :: Rep ComponentError x -> ComponentError #
Exception ComponentError #
Instance details Defined in Control.Monad.Component.Internal.Types Methods toException :: ComponentError -> SomeException # fromException :: SomeException -> Maybe ComponentError # displayException :: ComponentError -> String #
Pretty ComponentError #
Instance details Defined in Control.Monad.Component.Internal.Types Methods pretty :: ComponentError -> Doc ann # prettyList :: [ComponentError] -> Doc ann #
type Rep ComponentError #
Instance details Defined in Control.Monad.Component.Internal.Types type Rep ComponentError = D1 (MetaData "ComponentError" "Control.Monad.Component.Internal.Types" "componentm-0.0.0.2-9P7vJDAwb9tFXSdY8WXFfZ" False) (C1 (MetaCons "ComponentRuntimeFailed" PrefixI True) (S1 (MetaSel (Just "componentErrorOriginalException") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SomeException) :: S1 (MetaSel (Just "componentErrorTeardownResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TeardownResult)) :+: C1 (MetaCons "ComponentBuildFailed" PrefixI True) (S1 (MetaSel (Just "componentErrorBuildErrors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ComponentBuildError]) :: S1 (MetaSel (Just "componentErrorTeardownResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TeardownResult)))

data ComponentBuildError #

Exception raised on the execution of IO sub-routines used when constructing ComponentM values (e.g. buildComponent)

Constructors

DuplicatedComponentKeyDetected !Description	Failure thrown when using the same component key on a Component composition
ComponentAllocationFailed !Description !SomeException	Failure thrown when the allocation sub-routine of a Component fails with an exception
ComponentErrorThrown !SomeException	Failure thrown when calling the `throwM` when composing `ComponentM` values
ComponentIOLiftFailed !SomeException	Failure thrown when calling `liftIO` fails with an exception

Instances

Show ComponentBuildError #
Instance details Defined in Control.Monad.Component.Internal.Types Methods showsPrec :: Int -> ComponentBuildError -> ShowS # show :: ComponentBuildError -> String # showList :: [ComponentBuildError] -> ShowS #
Generic ComponentBuildError #
Instance details Defined in Control.Monad.Component.Internal.Types Associated Types type Rep ComponentBuildError :: * -> * # Methods from :: ComponentBuildError -> Rep ComponentBuildError x # to :: Rep ComponentBuildError x -> ComponentBuildError #
Exception ComponentBuildError #
Instance details Defined in Control.Monad.Component.Internal.Types Methods toException :: ComponentBuildError -> SomeException # fromException :: SomeException -> Maybe ComponentBuildError # displayException :: ComponentBuildError -> String #
Pretty ComponentBuildError #
Instance details Defined in Control.Monad.Component.Internal.Types Methods pretty :: ComponentBuildError -> Doc ann # prettyList :: [ComponentBuildError] -> Doc ann #
type Rep ComponentBuildError #
Instance details Defined in Control.Monad.Component.Internal.Types type Rep ComponentBuildError

newtype ComponentM a #

Represents the construction of a Component in your application, components may be composed using a Monad or Applicative interface.

Constructors

ComponentM (IO (Either ([ComponentBuildError], BuildTable) (a, BuildTable)))

Instances

Monad ComponentM #
Instance details Defined in Control.Monad.Component.Internal.Types Methods (>>=) :: ComponentM a -> (a -> ComponentM b) -> ComponentM b # (>>) :: ComponentM a -> ComponentM b -> ComponentM b # return :: a -> ComponentM a # fail :: String -> ComponentM a #
Functor ComponentM #
Instance details Defined in Control.Monad.Component.Internal.Types Methods fmap :: (a -> b) -> ComponentM a -> ComponentM b # (<$) :: a -> ComponentM b -> ComponentM a #
Applicative ComponentM #
Instance details Defined in Control.Monad.Component.Internal.Types Methods pure :: a -> ComponentM a # (<>) :: ComponentM (a -> b) -> ComponentM a -> ComponentM b # liftA2 :: (a -> b -> c) -> ComponentM a -> ComponentM b -> ComponentM c # (>) :: ComponentM a -> ComponentM b -> ComponentM b # (<*) :: ComponentM a -> ComponentM b -> ComponentM a #
MonadIO ComponentM #
Instance details Defined in Control.Monad.Component.Internal.Types Methods liftIO :: IO a -> ComponentM a #
MonadThrow ComponentM #
Instance details Defined in Control.Monad.Component.Internal.Types Methods throwM :: Exception e => e -> ComponentM a #

data Build #

Contains metadata about the build of a resource from a ComponentM value

Constructors

Build

Fields

componentDesc :: !Description
Name of the component built
componentTeardown :: !Teardown
Cleanup sub-routine of the component built
buildElapsedTime :: !NominalDiffTime
Elasped time in the allocation of a component resource
buildFailure :: !(Maybe SomeException)
Error thrown in the allocation of a component resource
buildDependencies :: !(Set Description)
What other components this build depends on

Instances

Generic Build #
Instance details Defined in Control.Monad.Component.Internal.Types Associated Types type Rep Build :: * -> * # Methods from :: Build -> Rep Build x # to :: Rep Build x -> Build #
Pretty Build #
Instance details Defined in Control.Monad.Component.Internal.Types Methods pretty :: Build -> Doc ann # prettyList :: [Build] -> Doc ann #
Display Build #
Instance details Defined in Control.Monad.Component.Internal.Types Methods display :: Build -> Utf8Builder #
type Rep Build #
Instance details Defined in Control.Monad.Component.Internal.Types type Rep Build

newtype BuildResult #

Wraps a collection of Build records

Constructors

BuildResult
Fields toBuildList :: [Build]

Instances

Pretty BuildResult #
Instance details Defined in Control.Monad.Component.Internal.Types Methods pretty :: BuildResult -> Doc ann # prettyList :: [BuildResult] -> Doc ann #
Display BuildResult #
Instance details Defined in Control.Monad.Component.Internal.Types Methods display :: BuildResult -> Utf8Builder #

data TeardownResult #

Result from a Teardown sub-routine

Instances

Show TeardownResult
Instance details Defined in Control.Teardown.Internal.Types Methods showsPrec :: Int -> TeardownResult -> ShowS # show :: TeardownResult -> String # showList :: [TeardownResult] -> ShowS #
Generic TeardownResult
Instance details Defined in Control.Teardown.Internal.Types Associated Types type Rep TeardownResult :: * -> * # Methods from :: TeardownResult -> Rep TeardownResult x # to :: Rep TeardownResult x -> TeardownResult #
NFData TeardownResult
Instance details Defined in Control.Teardown.Internal.Types Methods rnf :: TeardownResult -> () #
Pretty TeardownResult
Instance details Defined in Control.Teardown.Internal.Types Methods pretty :: TeardownResult -> Doc ann # prettyList :: [TeardownResult] -> Doc ann #
Display TeardownResult
Instance details Defined in Control.Teardown.Internal.Types Methods display :: TeardownResult -> Utf8Builder #
type Rep TeardownResult
Instance details Defined in Control.Teardown.Internal.Types type Rep TeardownResult = D1 (MetaData "TeardownResult" "Control.Teardown.Internal.Types" "teardown-0.5.0.0-EqHDb7Ray1S2n5naP8GEyW" False) (C1 (MetaCons "BranchResult" PrefixI True) ((S1 (MetaSel (Just "resultDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Description) :: S1 (MetaSel (Just "resultElapsedTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NominalDiffTime)) :: (S1 (MetaSel (Just "resultDidFail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :: S1 (MetaSel (Just "resultListing") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [TeardownResult]))) :+: (C1 (MetaCons "LeafResult" PrefixI True) (S1 (MetaSel (Just "resultDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Description) :: (S1 (MetaSel (Just "resultElapsedTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NominalDiffTime) :*: S1 (MetaSel (Just "resultError") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SomeException)))) :+: C1 (MetaCons "EmptyResult" PrefixI True) (S1 (MetaSel (Just "resultDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Description))))

data ComponentEvent #

An event record used to trace the execution of an application initialization and teardown

Constructors

ComponentBuilt !BuildResult
ComponentReleased !TeardownResult
ComponentErrorDetected !ComponentError

Instances

Pretty ComponentEvent #
Instance details Defined in Control.Monad.Component.Internal.Types Methods pretty :: ComponentEvent -> Doc ann # prettyList :: [ComponentEvent] -> Doc ann #
Display ComponentEvent #
Instance details Defined in Control.Monad.Component.Internal.Types Methods display :: ComponentEvent -> Utf8Builder #

buildTableToOrderedList :: BuildTable -> [Build] #

buildTableToTeardown :: Text -> BuildTable -> IO Teardown #