Safe Haskell	None
Language	GHC2021

Network.TypedProtocol.Documentation.Types

Synopsis

data AgencyID
- = ClientAgencyID
- | ServerAgencyID
- | NobodyAgencyID
data StateRef
- = AnyState
- | State !String
data ProtocolDescription codec = ProtocolDescription {
- protocolName :: String
- protocolDescription :: [Description]
- protocolIdentifier :: String
- protocolStates :: [(StateRef, [Description], AgencyID)]
- protocolMessages :: [MessageDescription codec]
}
data MessageDescription codec = MessageDescription {
- messageName :: String
- messageDescription :: [Description]
- messagePayload :: [String]
- messageFromState :: StateRef
- messageToState :: StateRef
- messageInfo :: FieldInfo codec
}
newtype Description = Description {
- descriptionParagraphs :: [String]
}

Documentation

data AgencyID Source #

Represents agency at the term level. Used to indicate which side has agency in a particular protocol state.

Constructors

ClientAgencyID
ServerAgencyID
NobodyAgencyID

Instances

Instances details

ToJSON AgencyID Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods toJSON :: AgencyID -> Value # toEncoding :: AgencyID -> Encoding # toJSONList :: [AgencyID] -> Value # toEncodingList :: [AgencyID] -> Encoding # omitField :: AgencyID -> Bool #
Bounded AgencyID Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods minBound :: AgencyID # maxBound :: AgencyID #
Enum AgencyID Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods succ :: AgencyID -> AgencyID # pred :: AgencyID -> AgencyID # toEnum :: Int -> AgencyID # fromEnum :: AgencyID -> Int # enumFrom :: AgencyID -> [AgencyID] # enumFromThen :: AgencyID -> AgencyID -> [AgencyID] # enumFromTo :: AgencyID -> AgencyID -> [AgencyID] # enumFromThenTo :: AgencyID -> AgencyID -> AgencyID -> [AgencyID] #
Read AgencyID Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods readsPrec :: Int -> ReadS AgencyID # readList :: ReadS [AgencyID] # readPrec :: ReadPrec AgencyID # readListPrec :: ReadPrec [AgencyID] #
Show AgencyID Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods showsPrec :: Int -> AgencyID -> ShowS # show :: AgencyID -> String # showList :: [AgencyID] -> ShowS #
Eq AgencyID Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods (==) :: AgencyID -> AgencyID -> Bool # (/=) :: AgencyID -> AgencyID -> Bool #
Ord AgencyID Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods compare :: AgencyID -> AgencyID -> Ordering # (<) :: AgencyID -> AgencyID -> Bool # (<=) :: AgencyID -> AgencyID -> Bool # (>) :: AgencyID -> AgencyID -> Bool # (>=) :: AgencyID -> AgencyID -> Bool # max :: AgencyID -> AgencyID -> AgencyID # min :: AgencyID -> AgencyID -> AgencyID #
Lift AgencyID Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods lift :: Quote m => AgencyID -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => AgencyID -> Code m AgencyID #

data StateRef Source #

Constructors

AnyState
State !String

Instances

Instances details

ToJSON StateRef Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods toJSON :: StateRef -> Value # toEncoding :: StateRef -> Encoding # toJSONList :: [StateRef] -> Value # toEncodingList :: [StateRef] -> Encoding # omitField :: StateRef -> Bool #
Read StateRef Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods readsPrec :: Int -> ReadS StateRef # readList :: ReadS [StateRef] # readPrec :: ReadPrec StateRef # readListPrec :: ReadPrec [StateRef] #
Show StateRef Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods showsPrec :: Int -> StateRef -> ShowS # show :: StateRef -> String # showList :: [StateRef] -> ShowS #
Eq StateRef Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods (==) :: StateRef -> StateRef -> Bool # (/=) :: StateRef -> StateRef -> Bool #
Ord StateRef Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods compare :: StateRef -> StateRef -> Ordering # (<) :: StateRef -> StateRef -> Bool # (<=) :: StateRef -> StateRef -> Bool # (>) :: StateRef -> StateRef -> Bool # (>=) :: StateRef -> StateRef -> Bool # max :: StateRef -> StateRef -> StateRef # min :: StateRef -> StateRef -> StateRef #

data ProtocolDescription codec Source #

Term-level representation of a typed protocol.

Constructors

ProtocolDescription

Fields

protocolName :: String
Human-readable protocol name
protocolDescription :: [Description]
protocolIdentifier :: String
Machine-readable identifier, may be used for things like protocol version negotiation.
protocolStates :: [(StateRef, [Description], AgencyID)]
List of the protocol's possible states, each entry being a state ID, a human-readable description, and an indication of agency (client or server).
protocolMessages :: [MessageDescription codec]

Instances

Instances details

ToJSON (ProtocolDescription codec) Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods toJSON :: ProtocolDescription codec -> Value # toEncoding :: ProtocolDescription codec -> Encoding # toJSONList :: [ProtocolDescription codec] -> Value # toEncodingList :: [ProtocolDescription codec] -> Encoding # omitField :: ProtocolDescription codec -> Bool #
Show (ProtocolDescription codec) Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods showsPrec :: Int -> ProtocolDescription codec -> ShowS # show :: ProtocolDescription codec -> String # showList :: [ProtocolDescription codec] -> ShowS #

data MessageDescription codec Source #

Term-level representation of a typed protocol message.

Constructors

MessageDescription

Fields

messageName :: String
messageDescription :: [Description]
messagePayload :: [String]
List of payload values for this message (free-form descriptions or type names)
messageFromState :: StateRef
References a protocolState in the parent ProtocolDescription by name.
messageToState :: StateRef
References a protocolState in the parent ProtocolDescription by name.
messageInfo :: FieldInfo codec

Instances

Instances details

ToJSON (MessageDescription codec) Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods toJSON :: MessageDescription codec -> Value # toEncoding :: MessageDescription codec -> Encoding # toJSONList :: [MessageDescription codec] -> Value # toEncodingList :: [MessageDescription codec] -> Encoding # omitField :: MessageDescription codec -> Bool #
Show (MessageDescription codec) Source #
Instance details Defined in Network.TypedProtocol.Documentation.Types Methods showsPrec :: Int -> MessageDescription codec -> ShowS # show :: MessageDescription codec -> String # showList :: [MessageDescription codec] -> ShowS #

newtype Description #

Used to add descriptions via ANN pragmas. This is necessary because Template Haskell cannot find Haddock comments attached to constructors inside associated types, but it can find annotations on those same constructors.

Constructors

Description
Fields descriptionParagraphs :: [String]

Instances

Instances details

Monoid Description
Instance details Defined in Data.SerDoc.Info Methods mempty :: Description # mappend :: Description -> Description -> Description # mconcat :: [Description] -> Description #
Semigroup Description
Instance details Defined in Data.SerDoc.Info Methods (<>) :: Description -> Description -> Description # sconcat :: NonEmpty Description -> Description # stimes :: Integral b => b -> Description -> Description #
Data Description
Instance details Defined in Data.SerDoc.Info Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Description -> c Description # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Description # toConstr :: Description -> Constr # dataTypeOf :: Description -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Description) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Description) # gmapT :: (forall b. Data b => b -> b) -> Description -> Description # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Description -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Description -> r # gmapQ :: (forall d. Data d => d -> u) -> Description -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Description -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Description -> m Description # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Description -> m Description # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Description -> m Description #
Read Description
Instance details Defined in Data.SerDoc.Info Methods readsPrec :: Int -> ReadS Description # readList :: ReadS [Description] # readPrec :: ReadPrec Description # readListPrec :: ReadPrec [Description] #
Show Description
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> Description -> ShowS # show :: Description -> String # showList :: [Description] -> ShowS #
Eq Description
Instance details Defined in Data.SerDoc.Info Methods (==) :: Description -> Description -> Bool # (/=) :: Description -> Description -> Bool #
Lift Description
Instance details Defined in Data.SerDoc.Info Methods lift :: Quote m => Description -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Description -> Code m Description #