plutus-tx-1.30.0.0: Libraries for Plutus Tx and its prelude
Safe HaskellSafe-Inferred
LanguageHaskell2010

PlutusTx.Blueprint.Schema.Annotation

Synopsis

Documentation

data SchemaInfo Source #

Additional information optionally attached to any datatype schema definition.

Instances

Instances details
Data SchemaInfo Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → SchemaInfo → c SchemaInfo Source #

gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c SchemaInfo Source #

toConstrSchemaInfoConstr Source #

dataTypeOfSchemaInfoDataType Source #

dataCast1Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c SchemaInfo) Source #

dataCast2Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c SchemaInfo) Source #

gmapT ∷ (∀ b. Data b ⇒ b → b) → SchemaInfoSchemaInfo Source #

gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → SchemaInfo → r Source #

gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → SchemaInfo → r Source #

gmapQ ∷ (∀ d. Data d ⇒ d → u) → SchemaInfo → [u] Source #

gmapQiInt → (∀ d. Data d ⇒ d → u) → SchemaInfo → u Source #

gmapMMonad m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaInfo → m SchemaInfo Source #

gmapMpMonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaInfo → m SchemaInfo Source #

gmapMoMonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaInfo → m SchemaInfo Source #

Generic SchemaInfo Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Associated Types

type Rep SchemaInfoTypeType Source #

Show SchemaInfo Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Eq SchemaInfo Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Ord SchemaInfo Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Lift SchemaInfo Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

liftQuote m ⇒ SchemaInfo → m Exp Source #

liftTyped ∷ ∀ (m ∷ TypeType). Quote m ⇒ SchemaInfoCode m SchemaInfo Source #

type Rep SchemaInfo Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

type Rep SchemaInfo = D1 ('MetaData "SchemaInfo" "PlutusTx.Blueprint.Schema.Annotation" "plutus-tx-1.30.0.0-inplace" 'False) (C1 ('MetaCons "MkSchemaInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe String)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe String)))))

data SchemaAnn Source #

Annotation that can be attached to a schema definition.

Instances

Instances details
Data SchemaAnn Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → SchemaAnn → c SchemaAnn Source #

gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c SchemaAnn Source #

toConstrSchemaAnnConstr Source #

dataTypeOfSchemaAnnDataType Source #

dataCast1Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c SchemaAnn) Source #

dataCast2Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c SchemaAnn) Source #

gmapT ∷ (∀ b. Data b ⇒ b → b) → SchemaAnnSchemaAnn Source #

gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → SchemaAnn → r Source #

gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → SchemaAnn → r Source #

gmapQ ∷ (∀ d. Data d ⇒ d → u) → SchemaAnn → [u] Source #

gmapQiInt → (∀ d. Data d ⇒ d → u) → SchemaAnn → u Source #

gmapMMonad m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaAnn → m SchemaAnn Source #

gmapMpMonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaAnn → m SchemaAnn Source #

gmapMoMonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaAnn → m SchemaAnn Source #

Generic SchemaAnn Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Associated Types

type Rep SchemaAnnTypeType Source #

Show SchemaAnn Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Eq SchemaAnn Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Ord SchemaAnn Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Lift SchemaAnn Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

liftQuote m ⇒ SchemaAnn → m Exp Source #

liftTyped ∷ ∀ (m ∷ TypeType). Quote m ⇒ SchemaAnnCode m SchemaAnn Source #

type Rep SchemaAnn Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

type Rep SchemaAnn = D1 ('MetaData "SchemaAnn" "PlutusTx.Blueprint.Schema.Annotation" "plutus-tx-1.30.0.0-inplace" 'False) (C1 ('MetaCons "MkSchemaAnnTitle" 'PrefixI 'False) (S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaTitle)) :+: (C1 ('MetaCons "MkSchemaAnnDescription" 'PrefixI 'False) (S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaDescription)) :+: C1 ('MetaCons "MkSchemaAnnComment" 'PrefixI 'False) (S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaComment))))

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 

Instances

Instances details
ToJSON SchemaTitle Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

toJSONSchemaTitle → Value

toEncodingSchemaTitle → Encoding

toJSONList ∷ [SchemaTitle] → Value

toEncodingList ∷ [SchemaTitle] → Encoding

omitFieldSchemaTitleBool

Data SchemaTitle Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → SchemaTitle → c SchemaTitle Source #

gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c SchemaTitle Source #

toConstrSchemaTitleConstr Source #

dataTypeOfSchemaTitleDataType Source #

dataCast1Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c SchemaTitle) Source #

dataCast2Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c SchemaTitle) Source #

gmapT ∷ (∀ b. Data b ⇒ b → b) → SchemaTitleSchemaTitle Source #

gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → SchemaTitle → r Source #

gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → SchemaTitle → r Source #

gmapQ ∷ (∀ d. Data d ⇒ d → u) → SchemaTitle → [u] Source #

gmapQiInt → (∀ d. Data d ⇒ d → u) → SchemaTitle → u Source #

gmapMMonad m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaTitle → m SchemaTitle Source #

gmapMpMonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaTitle → m SchemaTitle Source #

gmapMoMonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaTitle → m SchemaTitle Source #

Show SchemaTitle Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Eq SchemaTitle Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Ord SchemaTitle Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Lift SchemaTitle Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

liftQuote m ⇒ SchemaTitle → m Exp Source #

liftTyped ∷ ∀ (m ∷ TypeType). Quote m ⇒ SchemaTitleCode m SchemaTitle Source #

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

Instances

Instances details
ToJSON SchemaDescription Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Data SchemaDescription Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → SchemaDescription → c SchemaDescription Source #

gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c SchemaDescription Source #

toConstrSchemaDescriptionConstr Source #

dataTypeOfSchemaDescriptionDataType Source #

dataCast1Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c SchemaDescription) Source #

dataCast2Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c SchemaDescription) Source #

gmapT ∷ (∀ b. Data b ⇒ b → b) → SchemaDescriptionSchemaDescription Source #

gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → SchemaDescription → r Source #

gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → SchemaDescription → r Source #

gmapQ ∷ (∀ d. Data d ⇒ d → u) → SchemaDescription → [u] Source #

gmapQiInt → (∀ d. Data d ⇒ d → u) → SchemaDescription → u Source #

gmapMMonad m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaDescription → m SchemaDescription Source #

gmapMpMonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaDescription → m SchemaDescription Source #

gmapMoMonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaDescription → m SchemaDescription Source #

Show SchemaDescription Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Eq SchemaDescription Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Ord SchemaDescription Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Lift SchemaDescription Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

liftQuote m ⇒ SchemaDescription → m Exp Source #

liftTyped ∷ ∀ (m ∷ TypeType). Quote m ⇒ SchemaDescriptionCode m SchemaDescription Source #

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 

Instances

Instances details
ToJSON SchemaComment Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

toJSONSchemaComment → Value

toEncodingSchemaComment → Encoding

toJSONList ∷ [SchemaComment] → Value

toEncodingList ∷ [SchemaComment] → Encoding

omitFieldSchemaCommentBool

Data SchemaComment Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → SchemaComment → c SchemaComment Source #

gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c SchemaComment Source #

toConstrSchemaCommentConstr Source #

dataTypeOfSchemaCommentDataType Source #

dataCast1Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c SchemaComment) Source #

dataCast2Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c SchemaComment) Source #

gmapT ∷ (∀ b. Data b ⇒ b → b) → SchemaCommentSchemaComment Source #

gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → SchemaComment → r Source #

gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → SchemaComment → r Source #

gmapQ ∷ (∀ d. Data d ⇒ d → u) → SchemaComment → [u] Source #

gmapQiInt → (∀ d. Data d ⇒ d → u) → SchemaComment → u Source #

gmapMMonad m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaComment → m SchemaComment Source #

gmapMpMonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaComment → m SchemaComment Source #

gmapMoMonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SchemaComment → m SchemaComment Source #

Show SchemaComment Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Eq SchemaComment Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Ord SchemaComment Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Lift SchemaComment Source # 
Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

liftQuote m ⇒ SchemaComment → m Exp Source #

liftTyped ∷ ∀ (m ∷ TypeType). Quote m ⇒ SchemaCommentCode m SchemaComment Source #