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 Source #

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

Instances details

Exception ComponentError Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Methods

toException :: ComponentError -> SomeException #

fromException :: SomeException -> Maybe ComponentError #

displayException :: ComponentError -> String #

Generic ComponentError Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Associated Types

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-8ebyItofbp51gUDrplwObq" '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)))

Methods

from :: ComponentError -> Rep ComponentError x #

to :: Rep ComponentError x -> ComponentError #

Show ComponentError Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Methods

showsPrec :: Int -> ComponentError -> ShowS #

show :: ComponentError -> String #

showList :: [ComponentError] -> ShowS #

Pretty ComponentError Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Methods

pretty :: ComponentError -> Doc ann #

prettyList :: [ComponentError] -> Doc ann #

type Rep ComponentError Source #

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-8ebyItofbp51gUDrplwObq" '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 Source #

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

Instances details

Exception ComponentBuildError Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Methods

toException :: ComponentBuildError -> SomeException #

fromException :: SomeException -> Maybe ComponentBuildError #

displayException :: ComponentBuildError -> String #

Generic ComponentBuildError Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Associated Types

type Rep ComponentBuildError
Instance details Defined in Control.Monad.Component.Internal.Types type Rep ComponentBuildError

Methods

from :: ComponentBuildError -> Rep ComponentBuildError x #

to :: Rep ComponentBuildError x -> ComponentBuildError #

Show ComponentBuildError Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Methods

showsPrec :: Int -> ComponentBuildError -> ShowS #

show :: ComponentBuildError -> String #

showList :: [ComponentBuildError] -> ShowS #

Pretty ComponentBuildError Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Methods

pretty :: ComponentBuildError -> Doc ann #

prettyList :: [ComponentBuildError] -> Doc ann #

type Rep ComponentBuildError Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

type Rep ComponentBuildError

newtype ComponentM a Source #

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

Instances details

MonadIO ComponentM Source #
Instance details Defined in Control.Monad.Component.Internal.Types Methods liftIO :: IO a -> ComponentM a #
Applicative ComponentM Source #
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 #
Functor ComponentM Source #
Instance details Defined in Control.Monad.Component.Internal.Types Methods fmap :: (a -> b) -> ComponentM a -> ComponentM b # (<$) :: a -> ComponentM b -> ComponentM a #
Monad ComponentM Source #
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 #
MonadThrow ComponentM Source #
Instance details Defined in Control.Monad.Component.Internal.Types Methods throwM :: (HasCallStack, Exception e) => e -> ComponentM a #

data Build Source #

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

Instances details

Generic Build Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Associated Types

type Rep Build
Instance details Defined in Control.Monad.Component.Internal.Types type Rep Build

Methods

from :: Build -> Rep Build x #

to :: Rep Build x -> Build #

Pretty Build Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Methods

pretty :: Build -> Doc ann #

prettyList :: [Build] -> Doc ann #

Display Build Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

Methods

display :: Build -> Utf8Builder #

textDisplay :: Build -> Text #

type Rep Build Source #

Instance details

Defined in Control.Monad.Component.Internal.Types

type Rep Build

newtype BuildResult Source #

Wraps a collection of Build records

Constructors

BuildResult
Fields toBuildList :: [Build]

Instances

Instances details

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

data TeardownResult #

Result from a Teardown sub-routine

Instances

Instances details

Generic TeardownResult

Instance details

Defined in Control.Teardown.Internal.Types

Associated Types

type Rep TeardownResult

Instance details

Defined in Control.Teardown.Internal.Types

Methods

from :: TeardownResult -> Rep TeardownResult x #

to :: Rep TeardownResult x -> TeardownResult #

Show TeardownResult

Instance details

Defined in Control.Teardown.Internal.Types

Methods

showsPrec :: Int -> TeardownResult -> ShowS #

show :: TeardownResult -> String #

showList :: [TeardownResult] -> ShowS #

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 #

textDisplay :: TeardownResult -> Text #

type Rep TeardownResult

Instance details

Defined in Control.Teardown.Internal.Types

data ComponentEvent Source #

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

Constructors

ComponentBuilt !BuildResult
ComponentReleased !TeardownResult
ComponentErrorDetected !ComponentError

Instances

Instances details

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

buildTableToOrderedList :: BuildTable -> [Build] Source #

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