Data.Registry.Internal.Types

List of types used inside the Registry

Documentation

data Value

A Value is the Dynamic representation of a Haskell value + its description It is either provided by the user of the Registry or created as part of the resolution algorithm

Constructors

CreatedValue Dynamic ValueDescription

ProvidedValue Dynamic ValueDescription

Instances

Show Value

Defined in Data.Registry.Internal.Types

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

getValueDynamic :: Value -> Dynamic

Return the dynamic part of a value

data ValueDescription

Description of a value. It might just have a description for its type when it is a value created by the resolution algorithm

Constructors

ValueDescription

Fields

• _valueType :: Text
• _valueValue :: Maybe Text

Instances

Eq ValueDescription

Defined in Data.Registry.Internal.Types

Methods

(==) :: ValueDescription -> ValueDescription -> Bool

(/=) :: ValueDescription -> ValueDescription -> Bool

Show ValueDescription

Defined in Data.Registry.Internal.Types

Methods

showsPrec :: Int -> ValueDescription -> ShowS

show :: ValueDescription -> String

showList :: [ValueDescription] -> ShowS

describeValue :: (Typeable a, Show a) => a -> ValueDescription

Describe a value with its type and actual content

describeTypeableValue :: Typeable a => a -> ValueDescription

Describe a value with only its type

showValue :: Value -> Text

Show a Value from the Registry

createValue :: (Show a, Typeable a) => a -> Value

Create a Value from a Haskell value, with its Show description

createTypeableValue :: Typeable a => a -> Value

Create a Value from a Haskell value, with only its Typeable description

createDynValue :: Dynamic -> Text -> Value

Create a Value from a Dynamic value and some description

valueDynTypeRep :: Value -> SomeTypeRep

Type representation of a Value

valueDyn :: Value -> Dynamic

Dynamic representation of a Value

valDescription :: Value -> ValueDescription

The description for a Value

valDescriptionToText :: ValueDescription -> Text

A ValueDescription as Text. If the actual content of the Value is provided display the type first then the content

data Function

A Function is the Dynamic representation of a Haskell function + its description

Constructors

Function Dynamic FunctionDescription

Instances

Show Function

Defined in Data.Registry.Internal.Types

Methods

showsPrec :: Int -> Function -> ShowS

show :: Function -> String

showList :: [Function] -> ShowS

createFunction :: Typeable a => a -> Function

Create a Function value from a Haskell function

data FunctionDescription

Description of a Function with input types and output type

Constructors

FunctionDescription

Fields

• _inputTypes :: [Text]
• _outputType :: Text

Instances

Eq FunctionDescription

Defined in Data.Registry.Internal.Types

Methods

(==) :: FunctionDescription -> FunctionDescription -> Bool

(/=) :: FunctionDescription -> FunctionDescription -> Bool

Show FunctionDescription

Defined in Data.Registry.Internal.Types

Methods

showsPrec :: Int -> FunctionDescription -> ShowS

show :: FunctionDescription -> String

showList :: [FunctionDescription] -> ShowS

describeFunction :: Typeable a => a -> FunctionDescription

Describe a Function (which doesn't have a Show instance) that can be put in the Registry

showFunction :: Function -> Text

Show a Function as Text using its Description

funDescription :: Function -> FunctionDescription

The Description of a Function

funDyn :: Function -> Dynamic

Dynamic representation of a Function

funDynTypeRep :: Function -> SomeTypeRep

Type representation of a Function

funDescriptionToText :: FunctionDescription -> Text

A FunctionDescription as Text

hasParameters :: Function -> Bool

Return True if a Function has some input parameters

data Typed a

A Typed value or function can be added to a Registry It is either a value, having both Show and Typeable information or a function having just Typeable information

Constructors

TypedValue Value

TypedFunction Function

newtype Functions

This is a list of functions (or "constructors") available for constructing values

Constructors

Functions [Function]

Instances

Show Functions

Defined in Data.Registry.Internal.Types

Methods

showsPrec :: Int -> Functions -> ShowS

show :: Functions -> String

showList :: [Functions] -> ShowS

Semigroup Functions

Defined in Data.Registry.Internal.Types

Methods

(<>) :: Functions -> Functions -> Functions

sconcat :: NonEmpty Functions -> Functions

stimes :: Integral b => b -> Functions -> Functions

Monoid Functions

Defined in Data.Registry.Internal.Types

Methods

mempty :: Functions

mappend :: Functions -> Functions -> Functions

mconcat :: [Functions] -> Functions

describeFunctions :: Functions -> Text

Display a list of constructors

addFunction :: Function -> Functions -> Functions

Add one more Function to the list of Functions

newtype Values

List of values available which can be used as parameters to constructors for building other values

Constructors

Values [Value]

Instances

Show Values

Defined in Data.Registry.Internal.Types

Methods

showsPrec :: Int -> Values -> ShowS

show :: Values -> String

showList :: [Values] -> ShowS

Semigroup Values

Defined in Data.Registry.Internal.Types

Methods

(<>) :: Values -> Values -> Values

sconcat :: NonEmpty Values -> Values

stimes :: Integral b => b -> Values -> Values

Monoid Values

Defined in Data.Registry.Internal.Types

Methods

mempty :: Values

mappend :: Values -> Values -> Values

mconcat :: [Values] -> Values

describeValues :: Values -> Text

Display a list of values

addValue :: Value -> Values -> Values

Add one more Value to the list of Values

newtype Context

The types of values that we are trying to build at a given moment of the resolution algorithm

Constructors

Context

Fields

• _context :: [SomeTypeRep]

Instances

Show Context

Defined in Data.Registry.Internal.Types

Methods

showsPrec :: Int -> Context -> ShowS

show :: Context -> String

showList :: [Context] -> ShowS

Semigroup Context

Defined in Data.Registry.Internal.Types

Methods

(<>) :: Context -> Context -> Context

sconcat :: NonEmpty Context -> Context

stimes :: Integral b => b -> Context -> Context

Monoid Context

Defined in Data.Registry.Internal.Types

Methods

mempty :: Context

mappend :: Context -> Context -> Context

mconcat :: [Context] -> Context

newtype Specializations

Specification of values which become available for construction when a corresponding type comes in context

Constructors

Specializations [(SomeTypeRep, Value)]

Instances

Show Specializations

Defined in Data.Registry.Internal.Types

Methods

showsPrec :: Int -> Specializations -> ShowS

show :: Specializations -> String

showList :: [Specializations] -> ShowS

Semigroup Specializations

Defined in Data.Registry.Internal.Types

Methods

(<>) :: Specializations -> Specializations -> Specializations

sconcat :: NonEmpty Specializations -> Specializations

stimes :: Integral b => b -> Specializations -> Specializations

Monoid Specializations

Defined in Data.Registry.Internal.Types

Methods

mempty :: Specializations

mappend :: Specializations -> Specializations -> Specializations

mconcat :: [Specializations] -> Specializations

describeSpecializations :: Specializations -> Text

Display a list of specializations for the Registry, just showing the context (a type) in which a value must be selected

newtype Modifiers

List of functions modifying some values right after they have been built. This enables "tweaking" the creation process with slightly different results. Here SomeTypeRep is the target value type a and

Constructors

Modifiers [(SomeTypeRep, Function)]

Instances

Show Modifiers

Defined in Data.Registry.Internal.Types

Methods

showsPrec :: Int -> Modifiers -> ShowS

show :: Modifiers -> String

showList :: [Modifiers] -> ShowS

Semigroup Modifiers

Defined in Data.Registry.Internal.Types

Methods

(<>) :: Modifiers -> Modifiers -> Modifiers

sconcat :: NonEmpty Modifiers -> Modifiers

stimes :: Integral b => b -> Modifiers -> Modifiers

Monoid Modifiers

Defined in Data.Registry.Internal.Types

Methods

mempty :: Modifiers

mappend :: Modifiers -> Modifiers -> Modifiers

mconcat :: [Modifiers] -> Modifiers

describeModifiers :: Modifiers -> Text

Display a list of modifiers for the Registry, just showing the type of the modified value