Lorentz.Annotation

Type and field annotations for Lorentz types.

Documentation

class HasAnnotation a where

This class defines the type and field annotations for a given type. Right now the type annotations come from names in a named field, and field annotations are generated from the record fields.

Minimal complete definition

Nothing

Methods

getAnnotation :: Notes (ToT a)

default getAnnotation :: (GHasAnnotation (Rep a), GValueType (Rep a) ~ ToT a) => Notes (ToT a)

Instances

HasAnnotation Bool

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT Bool)

HasAnnotation Integer

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT Integer)

HasAnnotation Natural

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT Natural)

HasAnnotation ()

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT ())

HasAnnotation ByteString

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT ByteString)

HasAnnotation Address

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT Address)

HasAnnotation EpAddress

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT EpAddress)

HasAnnotation KeyHash

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT KeyHash)

HasAnnotation MText

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT MText)

HasAnnotation Mutez

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT Mutez)

HasAnnotation Operation

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT Operation)

HasAnnotation PublicKey

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT PublicKey)

HasAnnotation Signature

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT Signature)

HasAnnotation Timestamp

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT Timestamp)

HasAnnotation Empty

Defined in Lorentz.Empty

Methods

getAnnotation :: Notes (ToT Empty)

HasAnnotation a => HasAnnotation [a]

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT [a])

HasAnnotation a => HasAnnotation (Maybe a)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (Maybe a))

KnownIsoT v => HasAnnotation (Set v)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (Set v))

HasAnnotation a => HasAnnotation (ContractRef a)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (ContractRef a))

HasAnnotation (FutureContract a)

Defined in Lorentz.Address

Methods

getAnnotation :: Notes (ToT (FutureContract a))

HasAnnotation (UStore a)

Defined in Lorentz.UStore.Types

Methods

getAnnotation :: Notes (ToT (UStore a))

HasAnnotation (UParam entries)

Defined in Lorentz.UParam

Methods

getAnnotation :: Notes (ToT (UParam entries))

(HasAnnotation a, HasAnnotation b) => HasAnnotation (a, b)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (a, b))

(HasAnnotation k, HasAnnotation v) => HasAnnotation (Map k v)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (Map k v))

(HasAnnotation k, HasAnnotation v) => HasAnnotation (BigMap k v)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (BigMap k v))

(HasAnnotation (ZippedStack i), HasAnnotation (ZippedStack o)) => HasAnnotation (i :-> o)

Defined in Lorentz.Zip

Methods

getAnnotation :: Notes (ToT (i :-> o))

HasAnnotation (TAddress p)

Defined in Lorentz.Address

Methods

getAnnotation :: Notes (ToT (TAddress p))

HasAnnotation (MigrationScript oldStore newStore)

Defined in Lorentz.UStore.Migration.Base

Methods

getAnnotation :: Notes (ToT (MigrationScript oldStore newStore))

(HasAnnotation a, HasAnnotation b) => HasAnnotation (Void_ a b)

Defined in Lorentz.Macro

Methods

getAnnotation :: Notes (ToT (Void_ a b))

(HasAnnotation a, HasAnnotation r) => HasAnnotation (View a r)

Defined in Lorentz.Macro

Methods

getAnnotation :: Notes (ToT (View a r))

HasAnnotation (Extensible x)

Defined in Lorentz.Extensible

Methods

getAnnotation :: Notes (ToT (Extensible x))

(HasAnnotation a, HasAnnotation b, HasAnnotation c) => HasAnnotation (a, b, c)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (a, b, c))

(HasAnnotation (Maybe a), KnownSymbol name) => HasAnnotation (NamedF Maybe a name)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (NamedF Maybe a name))

(HasAnnotation a, KnownSymbol name) => HasAnnotation (NamedF Identity a name)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (NamedF Identity a name))

(HasAnnotation a, HasAnnotation b, HasAnnotation c, HasAnnotation d) => HasAnnotation (a, b, c, d)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (a, b, c, d))

(HasAnnotation a, HasAnnotation b, HasAnnotation c, HasAnnotation d, HasAnnotation e) => HasAnnotation (a, b, c, d, e)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (a, b, c, d, e))

(HasAnnotation a, HasAnnotation b, HasAnnotation c, HasAnnotation d, HasAnnotation e, HasAnnotation f) => HasAnnotation (a, b, c, d, e, f)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (a, b, c, d, e, f))

(HasAnnotation a, HasAnnotation b, HasAnnotation c, HasAnnotation d, HasAnnotation e, HasAnnotation f, HasAnnotation g) => HasAnnotation (a, b, c, d, e, f, g)

Defined in Lorentz.Annotation

Methods

getAnnotation :: Notes (ToT (a, b, c, d, e, f, g))

class GHasAnnotation a where

A Generic HasAnnotation implementation

Methods

gGetAnnotation :: Bool -> (Notes (GValueType a), FieldAnn)

Bool acts as a flag to determine whether or not field annotations should be set.

Instances

GHasAnnotation (U1 :: Type -> Type)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: Bool -> (Notes (GValueType U1), FieldAnn)

HasAnnotation x => GHasAnnotation (Rec0 x)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: Bool -> (Notes (GValueType (Rec0 x)), FieldAnn)

(GHasAnnotation x, GHasAnnotation y) => GHasAnnotation (x :+: y)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: Bool -> (Notes (GValueType (x :+: y)), FieldAnn)

(GHasAnnotation x, GHasAnnotation y) => GHasAnnotation (x :*: y)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: Bool -> (Notes (GValueType (x :*: y)), FieldAnn)

GHasAnnotation x => GHasAnnotation (M1 D i1 x)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: Bool -> (Notes (GValueType (M1 D i1 x)), FieldAnn)

GHasAnnotation x => GHasAnnotation (M1 C i1 x)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: Bool -> (Notes (GValueType (M1 C i1 x)), FieldAnn)

GHasAnnotation x => GHasAnnotation (M1 S ('MetaSel ('Nothing :: Maybe Symbol) b c d) x)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: Bool -> (Notes (GValueType (M1 S ('MetaSel 'Nothing b c d) x)), FieldAnn)

(GHasAnnotation x, KnownSymbol a) => GHasAnnotation (M1 S ('MetaSel ('Just a) b c d) x)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: Bool -> (Notes (GValueType (M1 S ('MetaSel ('Just a) b c d) x)), FieldAnn)

gGetAnnotationNoField :: forall a. (GHasAnnotation (Rep a), GValueType (Rep a) ~ ToT a) => Notes (ToT a)

Use this in the instance of HasAnnotation when field annotations should not be generated.

insertTypeAnn :: forall (b :: T). TypeAnn -> Notes b -> Notes b