Safe Haskell	None
Language	Haskell2010

PlutusTx.Blueprint.Schema.Annotation

Synopsis

data SchemaInfo = MkSchemaInfo {
- title :: Maybe String
- description :: Maybe String
- comment :: Maybe String
}
emptySchemaInfo :: SchemaInfo
annotationsToSchemaInfo :: [SchemaAnn] -> Either SchemaInfoError SchemaInfo
data SchemaAnn
newtype SchemaTitle = SchemaTitle {
- schemaTitleToString :: String
}
newtype SchemaDescription = SchemaDescription {
- schemaDescriptionToString :: String
}
newtype SchemaComment = SchemaComment {
- schemaCommentToString :: String
}

Documentation

data SchemaInfo Source #

Additional information optionally attached to any datatype schema definition.

Constructors

MkSchemaInfo
Fields title :: Maybe String description :: Maybe String comment :: Maybe String

Instances

Instances details

Data SchemaInfo Source #

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SchemaInfo -> c SchemaInfo Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SchemaInfo Source #

toConstr :: SchemaInfo -> Constr Source #

dataTypeOf :: SchemaInfo -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SchemaInfo) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SchemaInfo) Source #

gmapT :: (forall b. Data b => b -> b) -> SchemaInfo -> SchemaInfo Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SchemaInfo -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SchemaInfo -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> SchemaInfo -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SchemaInfo -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SchemaInfo -> m SchemaInfo Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SchemaInfo -> m SchemaInfo Source #

gmapMo :: MonadPlus m => (forall 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 SchemaInfo

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

type Rep SchemaInfo = D1 ('MetaData "SchemaInfo" "PlutusTx.Blueprint.Schema.Annotation" "plutus-tx-1.60.0.0-2VI8qZOpowK2Zo3DTnqORk" '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)))))

Methods

from :: SchemaInfo -> Rep SchemaInfo x Source #

to :: Rep SchemaInfo x -> SchemaInfo Source #

Show SchemaInfo Source #

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

showsPrec :: Int -> SchemaInfo -> ShowS Source #

show :: SchemaInfo -> String Source #

showList :: [SchemaInfo] -> ShowS Source #

Eq SchemaInfo Source #

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

(==) :: SchemaInfo -> SchemaInfo -> Bool Source #

(/=) :: SchemaInfo -> SchemaInfo -> Bool Source #

Ord SchemaInfo Source #

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

compare :: SchemaInfo -> SchemaInfo -> Ordering Source #

(<) :: SchemaInfo -> SchemaInfo -> Bool Source #

(<=) :: SchemaInfo -> SchemaInfo -> Bool Source #

(>) :: SchemaInfo -> SchemaInfo -> Bool Source #

(>=) :: SchemaInfo -> SchemaInfo -> Bool Source #

max :: SchemaInfo -> SchemaInfo -> SchemaInfo Source #

min :: SchemaInfo -> SchemaInfo -> SchemaInfo Source #

Lift SchemaInfo Source #

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

lift :: Quote m => SchemaInfo -> m Exp Source #

liftTyped :: forall (m :: Type -> Type). Quote m => SchemaInfo -> Code 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.60.0.0-2VI8qZOpowK2Zo3DTnqORk" '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)))))

emptySchemaInfo :: SchemaInfo Source #

annotationsToSchemaInfo :: [SchemaAnn] -> Either SchemaInfoError SchemaInfo Source #

data SchemaAnn Source #

Annotation that can be attached to a schema definition.

Constructors

MkSchemaAnnTitle SchemaTitle
MkSchemaAnnDescription SchemaDescription
MkSchemaAnnComment SchemaComment

Instances

Instances details

Data SchemaAnn Source #

Instance details

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 Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SchemaAnn Source #

toConstr :: SchemaAnn -> Constr Source #

dataTypeOf :: SchemaAnn -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SchemaAnn) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SchemaAnn) Source #

gmapT :: (forall b. Data b => b -> b) -> SchemaAnn -> SchemaAnn Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SchemaAnn -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SchemaAnn -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> SchemaAnn -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SchemaAnn -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SchemaAnn -> m SchemaAnn Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SchemaAnn -> m SchemaAnn Source #

gmapMo :: MonadPlus m => (forall 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 SchemaAnn

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

type Rep SchemaAnn = D1 ('MetaData "SchemaAnn" "PlutusTx.Blueprint.Schema.Annotation" "plutus-tx-1.60.0.0-2VI8qZOpowK2Zo3DTnqORk" '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))))

Methods

from :: SchemaAnn -> Rep SchemaAnn x Source #

to :: Rep SchemaAnn x -> SchemaAnn Source #

Show SchemaAnn Source #

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

showsPrec :: Int -> SchemaAnn -> ShowS Source #

show :: SchemaAnn -> String Source #

showList :: [SchemaAnn] -> ShowS Source #

Eq SchemaAnn Source #

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

(==) :: SchemaAnn -> SchemaAnn -> Bool Source #

(/=) :: SchemaAnn -> SchemaAnn -> Bool Source #

Ord SchemaAnn Source #

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

compare :: SchemaAnn -> SchemaAnn -> Ordering Source #

(<) :: SchemaAnn -> SchemaAnn -> Bool Source #

(<=) :: SchemaAnn -> SchemaAnn -> Bool Source #

(>) :: SchemaAnn -> SchemaAnn -> Bool Source #

(>=) :: SchemaAnn -> SchemaAnn -> Bool Source #

max :: SchemaAnn -> SchemaAnn -> SchemaAnn Source #

min :: SchemaAnn -> SchemaAnn -> SchemaAnn Source #

Lift SchemaAnn Source #

Instance details

Defined in PlutusTx.Blueprint.Schema.Annotation

Methods

lift :: Quote m => SchemaAnn -> m Exp Source #

liftTyped :: forall (m :: Type -> Type). Quote m => SchemaAnn -> Code 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.60.0.0-2VI8qZOpowK2Zo3DTnqORk" '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 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 schemaTitleToString :: String

Instances

Instances details

ToJSON SchemaTitle Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods toJSON :: SchemaTitle -> Value toEncoding :: SchemaTitle -> Encoding toJSONList :: [SchemaTitle] -> Value toEncodingList :: [SchemaTitle] -> Encoding omitField :: SchemaTitle -> Bool
Data SchemaTitle Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SchemaTitle -> c SchemaTitle Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SchemaTitle Source # toConstr :: SchemaTitle -> Constr Source # dataTypeOf :: SchemaTitle -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SchemaTitle) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SchemaTitle) Source # gmapT :: (forall b. Data b => b -> b) -> SchemaTitle -> SchemaTitle Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SchemaTitle -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SchemaTitle -> r Source # gmapQ :: (forall d. Data d => d -> u) -> SchemaTitle -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> SchemaTitle -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SchemaTitle -> m SchemaTitle Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SchemaTitle -> m SchemaTitle Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SchemaTitle -> m SchemaTitle Source #
Show SchemaTitle Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods showsPrec :: Int -> SchemaTitle -> ShowS Source # show :: SchemaTitle -> String Source # showList :: [SchemaTitle] -> ShowS Source #
Eq SchemaTitle Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods (==) :: SchemaTitle -> SchemaTitle -> Bool Source # (/=) :: SchemaTitle -> SchemaTitle -> Bool Source #
Ord SchemaTitle Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods compare :: SchemaTitle -> SchemaTitle -> Ordering Source # (<) :: SchemaTitle -> SchemaTitle -> Bool Source # (<=) :: SchemaTitle -> SchemaTitle -> Bool Source # (>) :: SchemaTitle -> SchemaTitle -> Bool Source # (>=) :: SchemaTitle -> SchemaTitle -> Bool Source # max :: SchemaTitle -> SchemaTitle -> SchemaTitle Source # min :: SchemaTitle -> SchemaTitle -> SchemaTitle Source #
Lift SchemaTitle Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods lift :: Quote m => SchemaTitle -> m Exp Source # liftTyped :: forall (m :: Type -> Type). Quote m => SchemaTitle -> Code 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

Constructors

SchemaDescription
Fields schemaDescriptionToString :: String

Instances

Instances details

ToJSON SchemaDescription Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods toJSON :: SchemaDescription -> Value toEncoding :: SchemaDescription -> Encoding toJSONList :: [SchemaDescription] -> Value toEncodingList :: [SchemaDescription] -> Encoding omitField :: SchemaDescription -> Bool
Data SchemaDescription Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SchemaDescription -> c SchemaDescription Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SchemaDescription Source # toConstr :: SchemaDescription -> Constr Source # dataTypeOf :: SchemaDescription -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SchemaDescription) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SchemaDescription) Source # gmapT :: (forall b. Data b => b -> b) -> SchemaDescription -> SchemaDescription Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SchemaDescription -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SchemaDescription -> r Source # gmapQ :: (forall d. Data d => d -> u) -> SchemaDescription -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> SchemaDescription -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SchemaDescription -> m SchemaDescription Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SchemaDescription -> m SchemaDescription Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SchemaDescription -> m SchemaDescription Source #
Show SchemaDescription Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods showsPrec :: Int -> SchemaDescription -> ShowS Source # show :: SchemaDescription -> String Source # showList :: [SchemaDescription] -> ShowS Source #
Eq SchemaDescription Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods (==) :: SchemaDescription -> SchemaDescription -> Bool Source # (/=) :: SchemaDescription -> SchemaDescription -> Bool Source #
Ord SchemaDescription Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods compare :: SchemaDescription -> SchemaDescription -> Ordering Source # (<) :: SchemaDescription -> SchemaDescription -> Bool Source # (<=) :: SchemaDescription -> SchemaDescription -> Bool Source # (>) :: SchemaDescription -> SchemaDescription -> Bool Source # (>=) :: SchemaDescription -> SchemaDescription -> Bool Source # max :: SchemaDescription -> SchemaDescription -> SchemaDescription Source # min :: SchemaDescription -> SchemaDescription -> SchemaDescription Source #
Lift SchemaDescription Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods lift :: Quote m => SchemaDescription -> m Exp Source # liftTyped :: forall (m :: Type -> Type). Quote m => SchemaDescription -> Code 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
Fields schemaCommentToString :: String

Instances

Instances details

ToJSON SchemaComment Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods toJSON :: SchemaComment -> Value toEncoding :: SchemaComment -> Encoding toJSONList :: [SchemaComment] -> Value toEncodingList :: [SchemaComment] -> Encoding omitField :: SchemaComment -> Bool
Data SchemaComment Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SchemaComment -> c SchemaComment Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SchemaComment Source # toConstr :: SchemaComment -> Constr Source # dataTypeOf :: SchemaComment -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SchemaComment) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SchemaComment) Source # gmapT :: (forall b. Data b => b -> b) -> SchemaComment -> SchemaComment Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SchemaComment -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SchemaComment -> r Source # gmapQ :: (forall d. Data d => d -> u) -> SchemaComment -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> SchemaComment -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SchemaComment -> m SchemaComment Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SchemaComment -> m SchemaComment Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SchemaComment -> m SchemaComment Source #
Show SchemaComment Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods showsPrec :: Int -> SchemaComment -> ShowS Source # show :: SchemaComment -> String Source # showList :: [SchemaComment] -> ShowS Source #
Eq SchemaComment Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods (==) :: SchemaComment -> SchemaComment -> Bool Source # (/=) :: SchemaComment -> SchemaComment -> Bool Source #
Ord SchemaComment Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods compare :: SchemaComment -> SchemaComment -> Ordering Source # (<) :: SchemaComment -> SchemaComment -> Bool Source # (<=) :: SchemaComment -> SchemaComment -> Bool Source # (>) :: SchemaComment -> SchemaComment -> Bool Source # (>=) :: SchemaComment -> SchemaComment -> Bool Source # max :: SchemaComment -> SchemaComment -> SchemaComment Source # min :: SchemaComment -> SchemaComment -> SchemaComment Source #
Lift SchemaComment Source #
Instance details Defined in PlutusTx.Blueprint.Schema.Annotation Methods lift :: Quote m => SchemaComment -> m Exp Source # liftTyped :: forall (m :: Type -> Type). Quote m => SchemaComment -> Code m SchemaComment Source #