cardano-shell-0.1.0.0
Safe HaskellNone
LanguageHaskell2010

Cardano.Shell.Types

Synopsis

Documentation

data CardanoFeature Source #

The interface for the running feature, the high-level interface we use for running it.

Constructors

CardanoFeature 

Fields

data CardanoFeatureInit env dependency cardanoConfiguration featureConfiguration layer Source #

Cardano feature initialization. We are saying "you have the responsibility to make sure you use the right context!".

Constructors

CardanoFeatureInit 

Fields

  • featureType :: !Text

    The type of the feature that we use.

  • featureInit :: env -> dependency -> cardanoConfiguration -> featureConfiguration -> IO layer

    Again, we are not sure how is the user going to run the actual feature, so we provide him with the most flexible/powerful context we have, IO. Notice the arrangement of the parameters - specific, general, specific, general, result.

  • featureCleanup :: layer -> IO ()

    If the user wants to clean up the resources after the module has completed running, there is an option to do so.

data NoDependency Source #

The option to not have any additional dependency for the CardanoFeature.

Constructors

NoDependency 

Instances

Instances details
Eq NoDependency Source # 
Instance details

Defined in Cardano.Shell.Types

Show NoDependency Source # 
Instance details

Defined in Cardano.Shell.Types

newtype CardanoApplication Source #

The top level module we use to run the key functions.

Constructors

CardanoApplication 

applicationProductionMode :: ApplicationEnvironment -> Bool Source #

A simple function to inform us.