Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.ProtocolBuffers.Types

Description

Elements in the Protocol Buffers syntax, as defined in https://developers.google.com/protocol-buffers/docs/reference/proto3-spec

Synopsis

type Identifier = Text
type FullIdentifier = [Identifier]
data ProtoBuf = ProtoBuf {
- syntax :: Maybe Text
- package :: Maybe FullIdentifier
- imports :: [(ImportType, Text)]
- options :: [Option]
- types :: [TypeDeclaration]
- services :: [ServiceDeclaration]
}
declsToProtoBuf :: [Declaration] -> ProtoBuf
safeHead :: [a] -> Maybe a
data Declaration where
- DSyntax :: Text -> Declaration
- DImport :: ImportType -> Text -> Declaration
- DPackage :: FullIdentifier -> Declaration
- DOption :: Option -> Declaration
- DType :: TypeDeclaration -> Declaration
- DService :: ServiceDeclaration -> Declaration
data Option where
- Option :: FullIdentifier -> Constant -> Option
data TypeDeclaration where
- DEnum :: Identifier -> [Option] -> [EnumField] -> TypeDeclaration
- DMessage :: Identifier -> [Option] -> [Reserved] -> [MessageField] -> [TypeDeclaration] -> TypeDeclaration
data ServiceDeclaration where
- Service :: Identifier -> [Option] -> [Method] -> ServiceDeclaration
data Method where
- Method :: Identifier -> Repetition -> FieldType -> Repetition -> FieldType -> [Option] -> Method
data ImportType
- = Normal
- | Weak
- | Public
data Constant where
- KIdentifier :: FullIdentifier -> Constant
- KInt :: Integer -> Constant
- KFloat :: Float -> Constant
- KString :: Text -> Constant
- KBool :: Bool -> Constant
- KObject :: [(Text, Constant)] -> Constant
data EnumField where
- EnumField :: FieldName -> FieldNumber -> [Option] -> EnumField
type TypeName = FullIdentifier
data FieldType
- = TInt32
- | TInt64
- | TUInt32
- | TUInt64
- | TSInt32
- | TSInt64
- | TFixed32
- | TFixed64
- | TSFixed32
- | TSFixed64
- | TDouble
- | TBool
- | TString
- | TBytes
- | TOther TypeName
type FieldName = Identifier
type FieldNumber = Int
data MessageField where
- NormalField :: Repetition -> FieldType -> FieldName -> FieldNumber -> [Option] -> MessageField
- OneOfField :: FieldName -> [MessageField] -> MessageField
- MapField :: FieldType -> FieldType -> FieldName -> FieldNumber -> [Option] -> MessageField
data Repetition
- = Single
- | Repeated
pattern Stream :: Repetition
type Reserved = [ReservedValue]
data ReservedValue where
- RInt :: Int -> ReservedValue
- RRange :: Int -> Int -> ReservedValue
- RName :: Identifier -> ReservedValue

Documentation

type Identifier = Text Source #

type FullIdentifier = [Identifier] Source #

data ProtoBuf Source #

Whole definition, in which declarations are sorted out by their form.

Constructors

ProtoBuf
Fields syntax :: Maybe Text package :: Maybe FullIdentifier imports :: [(ImportType, Text)] options :: [Option] types :: [TypeDeclaration] services :: [ServiceDeclaration]

Instances

Instances details

Show ProtoBuf Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> ProtoBuf -> ShowS # show :: ProtoBuf -> String # showList :: [ProtoBuf] -> ShowS #
Eq ProtoBuf Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: ProtoBuf -> ProtoBuf -> Bool # (/=) :: ProtoBuf -> ProtoBuf -> Bool #

declsToProtoBuf :: [Declaration] -> ProtoBuf Source #

safeHead :: [a] -> Maybe a Source #

data Declaration where Source #

Declarations, that is, anything which may appear in the top-level.

Constructors

DSyntax :: Text -> Declaration
DImport :: ImportType -> Text -> Declaration
DPackage :: FullIdentifier -> Declaration
DOption :: Option -> Declaration
DType :: TypeDeclaration -> Declaration
DService :: ServiceDeclaration -> Declaration

Instances

Instances details

Show Declaration Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS #
Eq Declaration Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: Declaration -> Declaration -> Bool # (/=) :: Declaration -> Declaration -> Bool #

data Option where Source #

Constructors

Option :: FullIdentifier -> Constant -> Option

Instances

Instances details

Show Option Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> Option -> ShowS # show :: Option -> String # showList :: [Option] -> ShowS #
Eq Option Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: Option -> Option -> Bool # (/=) :: Option -> Option -> Bool #

data TypeDeclaration where Source #

Constructors

DEnum :: Identifier -> [Option] -> [EnumField] -> TypeDeclaration
DMessage :: Identifier -> [Option] -> [Reserved] -> [MessageField] -> [TypeDeclaration] -> TypeDeclaration

Instances

Instances details

Show TypeDeclaration Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> TypeDeclaration -> ShowS # show :: TypeDeclaration -> String # showList :: [TypeDeclaration] -> ShowS #
Eq TypeDeclaration Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: TypeDeclaration -> TypeDeclaration -> Bool # (/=) :: TypeDeclaration -> TypeDeclaration -> Bool #

data ServiceDeclaration where Source #

Constructors

Service :: Identifier -> [Option] -> [Method] -> ServiceDeclaration

Instances

Instances details

Show ServiceDeclaration Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> ServiceDeclaration -> ShowS # show :: ServiceDeclaration -> String # showList :: [ServiceDeclaration] -> ShowS #
Eq ServiceDeclaration Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: ServiceDeclaration -> ServiceDeclaration -> Bool # (/=) :: ServiceDeclaration -> ServiceDeclaration -> Bool #

data Method where Source #

Constructors

Method :: Identifier -> Repetition -> FieldType -> Repetition -> FieldType -> [Option] -> Method

Instances

Instances details

Show Method Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
Eq Method Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #

data ImportType Source #

Constructors

Normal
Weak
Public

Instances

Instances details

Show ImportType Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> ImportType -> ShowS # show :: ImportType -> String # showList :: [ImportType] -> ShowS #
Eq ImportType Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: ImportType -> ImportType -> Bool # (/=) :: ImportType -> ImportType -> Bool #

data Constant where Source #

Constructors

KIdentifier :: FullIdentifier -> Constant
KInt :: Integer -> Constant
KFloat :: Float -> Constant
KString :: Text -> Constant
KBool :: Bool -> Constant
KObject :: [(Text, Constant)] -> Constant

Instances

Instances details

Show Constant Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> Constant -> ShowS # show :: Constant -> String # showList :: [Constant] -> ShowS #
Eq Constant Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: Constant -> Constant -> Bool # (/=) :: Constant -> Constant -> Bool #

data EnumField where Source #

Constructors

EnumField :: FieldName -> FieldNumber -> [Option] -> EnumField

Instances

Instances details

Show EnumField Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> EnumField -> ShowS # show :: EnumField -> String # showList :: [EnumField] -> ShowS #
Eq EnumField Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: EnumField -> EnumField -> Bool # (/=) :: EnumField -> EnumField -> Bool #

type TypeName = FullIdentifier Source #

data FieldType Source #

Constructors

TInt32
TInt64
TUInt32
TUInt64
TSInt32
TSInt64
TFixed32
TFixed64
TSFixed32
TSFixed64
TDouble
TBool
TString
TBytes
TOther TypeName

Instances

Instances details

Show FieldType Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> FieldType -> ShowS # show :: FieldType -> String # showList :: [FieldType] -> ShowS #
Eq FieldType Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: FieldType -> FieldType -> Bool # (/=) :: FieldType -> FieldType -> Bool #

type FieldName = Identifier Source #

type FieldNumber = Int Source #

data MessageField where Source #

Constructors

NormalField :: Repetition -> FieldType -> FieldName -> FieldNumber -> [Option] -> MessageField
OneOfField :: FieldName -> [MessageField] -> MessageField
MapField :: FieldType -> FieldType -> FieldName -> FieldNumber -> [Option] -> MessageField

Instances

Instances details

Show MessageField Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> MessageField -> ShowS # show :: MessageField -> String # showList :: [MessageField] -> ShowS #
Eq MessageField Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: MessageField -> MessageField -> Bool # (/=) :: MessageField -> MessageField -> Bool #

data Repetition Source #

Constructors

Single
Repeated

Instances

Instances details

Show Repetition Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> Repetition -> ShowS # show :: Repetition -> String # showList :: [Repetition] -> ShowS #
Eq Repetition Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: Repetition -> Repetition -> Bool # (/=) :: Repetition -> Repetition -> Bool #

pattern Stream :: Repetition Source #

type Reserved = [ReservedValue] Source #

data ReservedValue where Source #

Constructors

RInt :: Int -> ReservedValue
RRange :: Int -> Int -> ReservedValue
RName :: Identifier -> ReservedValue

Instances

Instances details

Show ReservedValue Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods showsPrec :: Int -> ReservedValue -> ShowS # show :: ReservedValue -> String # showList :: [ReservedValue] -> ShowS #
Eq ReservedValue Source #
Instance details Defined in Language.ProtocolBuffers.Types Methods (==) :: ReservedValue -> ReservedValue -> Bool # (/=) :: ReservedValue -> ReservedValue -> Bool #