| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
PlutusTx.Blueprint.Schema.Annotation
Synopsis
- data SchemaInfo = MkSchemaInfo {}
- emptySchemaInfo ∷ SchemaInfo
- annotationsToSchemaInfo ∷ [SchemaAnn] → Either SchemaInfoError SchemaInfo
- data SchemaAnn
- newtype SchemaTitle = SchemaTitle {}
- newtype SchemaDescription = SchemaDescription {}
- newtype SchemaComment = SchemaComment {}
Documentation
data SchemaInfo Source #
Additional information optionally attached to any datatype schema definition.
Constructors
| MkSchemaInfo | |
Instances
annotationsToSchemaInfo ∷ [SchemaAnn] → Either SchemaInfoError SchemaInfo Source #
Annotation that can be attached to a schema definition.
Constructors
| MkSchemaAnnTitle SchemaTitle | |
| MkSchemaAnnDescription SchemaDescription | |
| MkSchemaAnnComment SchemaComment |
Instances
newtype SchemaTitle Source #
An annotation for the "title" schema attribute.
This annotation could be attached to a type or constructor:
{-# ANN type MyFoo (SchemaTitle "My Foo Title") #-}
{-# ANN MkMyFoo (SchemaTitle Title) #-}
newtype MyFoo = MkMyFoo Int
Constructors
| SchemaTitle | |
Fields | |
Instances
newtype SchemaDescription Source #
An annotation for the "description" schema attribute.
This annotation could be attached to a type or constructor:
{-# ANN type MyFoo (SchemaDescription "My Foo Description") #-}
{-# ANN MkMyFoo (SchemaDescription Description) #-}
newtype MyFoo = MkMyFoo Int
Constructors
| SchemaDescription | |
Fields | |
Instances
newtype SchemaComment Source #
An annotation for the "$comment" schema attribute.
This annotation could be attached to a type or constructor:
{-# ANN type MyFoo (SchemaComment "My Foo Comment") #-}
{-# ANN MkMyFoo (SchemaComment Comment) #-}
newtype MyFoo = MkMyFoo Int
Constructors
| SchemaComment | |
Fields | |