Swarm.Doc.Command

Auto-generation of command attributes matrix.

Documentation

data DerivedAttrs

Constructors

DerivedAttrs

Fields

• hasActorTarget :: Bool
• pureComputation :: Bool
• modifiesEnvironment :: Bool
• modifiesRobot :: Bool
• movesRobot :: Bool
• returnsValue :: Bool
• outputType :: String

Instances

ToJSON DerivedAttrs

Defined in Swarm.Doc.Command

Methods

toJSON :: DerivedAttrs -> Value

toEncoding :: DerivedAttrs -> Encoding

toJSONList :: [DerivedAttrs] -> Value

toEncodingList :: [DerivedAttrs] -> Encoding

omitField :: DerivedAttrs -> Bool

Generic DerivedAttrs

Defined in Swarm.Doc.Command

Associated Types

type Rep DerivedAttrs :: Type -> Type

Methods

from :: DerivedAttrs -> Rep DerivedAttrs x

to :: Rep DerivedAttrs x -> DerivedAttrs

type Rep DerivedAttrs

Defined in Swarm.Doc.Command

type Rep DerivedAttrs = D1 ('MetaData "DerivedAttrs" "Swarm.Doc.Command" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-doc" 'False) (C1 ('MetaCons "DerivedAttrs" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hasActorTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "pureComputation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "modifiesEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "modifiesRobot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "movesRobot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "returnsValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "outputType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)))))

data CommandEntry

Constructors

CommandEntry

Fields

• cmd :: Const
• effects :: Set CommandEffect
• argTypes :: NonEmpty Type
• derivedAttrs :: DerivedAttrs

Instances

ToJSON CommandEntry

Defined in Swarm.Doc.Command

Methods

toJSON :: CommandEntry -> Value

toEncoding :: CommandEntry -> Encoding

toJSONList :: [CommandEntry] -> Value

toEncodingList :: [CommandEntry] -> Encoding

omitField :: CommandEntry -> Bool

Generic CommandEntry

Defined in Swarm.Doc.Command

Associated Types

type Rep CommandEntry :: Type -> Type

Methods

from :: CommandEntry -> Rep CommandEntry x

to :: Rep CommandEntry x -> CommandEntry

type Rep CommandEntry

Defined in Swarm.Doc.Command

type Rep CommandEntry = D1 ('MetaData "CommandEntry" "Swarm.Doc.Command" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-doc" 'False) (C1 ('MetaCons "CommandEntry" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cmd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Const) :*: S1 ('MetaSel ('Just "effects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Set CommandEffect))) :*: (S1 ('MetaSel ('Just "argTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Type)) :*: S1 ('MetaSel ('Just "derivedAttrs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DerivedAttrs))))

newtype CommandCatalog

Constructors

CommandCatalog

Fields

• entries :: [CommandEntry]

Instances

ToJSON CommandCatalog

Defined in Swarm.Doc.Command

Methods

toJSON :: CommandCatalog -> Value

toEncoding :: CommandCatalog -> Encoding

toJSONList :: [CommandCatalog] -> Value

toEncodingList :: [CommandCatalog] -> Encoding

omitField :: CommandCatalog -> Bool

Generic CommandCatalog

Defined in Swarm.Doc.Command

Associated Types

type Rep CommandCatalog :: Type -> Type

Methods

from :: CommandCatalog -> Rep CommandCatalog x

to :: Rep CommandCatalog x -> CommandCatalog

ToSample CommandCatalog

Defined in Swarm.Doc.Command

Methods

toSamples :: Proxy CommandCatalog -> [(Text, CommandCatalog)]

type Rep CommandCatalog

Defined in Swarm.Doc.Command

type Rep CommandCatalog = D1 ('MetaData "CommandCatalog" "Swarm.Doc.Command" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-doc" 'True) (C1 ('MetaCons "CommandCatalog" 'PrefixI 'True) (S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CommandEntry])))

mkEntry :: Const -> CommandEntry

Uses explicit effects documentation as well as type signature information to compute various flags

getCatalog :: CommandCatalog