| 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 #
Additional information optionally attached to any datatype schema definition.
Constructors
| MkSchemaInfo | |
Instances
annotationsToSchemaInfo :: [SchemaAnn] -> Either SchemaInfoError SchemaInfo #
Annotation that can be attached to a schema definition.
Constructors
| MkSchemaAnnTitle SchemaTitle | |
| MkSchemaAnnDescription SchemaDescription | |
| MkSchemaAnnComment SchemaComment |
Instances
| Data SchemaAnn # | |
Defined in PlutusTx.Blueprint.Schema.Annotation Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SchemaAnn -> c SchemaAnn # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SchemaAnn # toConstr :: SchemaAnn -> Constr # dataTypeOf :: SchemaAnn -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SchemaAnn) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SchemaAnn) # gmapT :: (forall b. Data b => b -> b) -> SchemaAnn -> SchemaAnn # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SchemaAnn -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SchemaAnn -> r # gmapQ :: (forall d. Data d => d -> u) -> SchemaAnn -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SchemaAnn -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SchemaAnn -> m SchemaAnn # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SchemaAnn -> m SchemaAnn # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SchemaAnn -> m SchemaAnn # | |
| Generic SchemaAnn # | |
| Show SchemaAnn # | |
| Eq SchemaAnn # | |
| Ord SchemaAnn # | |
Defined in PlutusTx.Blueprint.Schema.Annotation | |
| Lift SchemaAnn # | |
| type Rep SchemaAnn # | |
Defined in PlutusTx.Blueprint.Schema.Annotation type Rep SchemaAnn = D1 ('MetaData "SchemaAnn" "PlutusTx.Blueprint.Schema.Annotation" "plutus-tx-1.60.0.0-inplace" 'False) (C1 ('MetaCons "MkSchemaAnnTitle" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaTitle)) :+: (C1 ('MetaCons "MkSchemaAnnDescription" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaDescription)) :+: C1 ('MetaCons "MkSchemaAnnComment" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaComment)))) | |
newtype SchemaTitle #
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
newtype SchemaDescription #
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
newtype SchemaComment #
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