Safe Haskell	None
Language	Haskell2010

Language.Avro.Types

Description

Language definition for AVRO (.avdl) files, as defined in http://avro.apache.org/docs/1.8.2/spec.html.

Synopsis

data Method = Method {
- mname :: Text
- args :: [Argument]
- result :: Schema
- throws :: Schema
- oneway :: Bool
}
data Argument = Argument {
- atype :: Schema
- aname :: Text
}
data ImportType
- = IdlImport Text
- | ProtocolImport Text
- | SchemaImport Text
data Annotation = Annotation {
- ann :: Text
- abody :: Text
}
type Aliases = [TypeName]
newtype Namespace = Namespace [Text]
data Protocol = Protocol {
- ns :: Maybe Namespace
- pname :: Text
- imports :: [ImportType]
- types :: [Schema]
- messages :: [Method]
}
type Schema = Type

Documentation

data Method Source #

Type for methods/messages that belong to a protocol.

Constructors

Method
Fields mname :: Text args :: [Argument] result :: Schema throws :: Schema oneway :: Bool

Instances

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

data Argument Source #

Helper type for the arguments of Method.

Constructors

Argument
Fields atype :: Schema aname :: Text

Instances

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

data ImportType Source #

Type for the possible import types in Protocol.

Constructors

IdlImport Text
ProtocolImport Text
SchemaImport Text

Instances

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

data Annotation Source #

Type for special annotations.

Constructors

Annotation
Fields ann :: Text abody :: Text

Instances

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

type Aliases = [TypeName] Source #

newtype Namespace Source #

Newtype for the namespace of methods and protocols.

Constructors

Namespace [Text]

Instances

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

data Protocol Source #

Whole definition of protocol.

Constructors

Protocol
Fields ns :: Maybe Namespace pname :: Text imports :: [ImportType] types :: [Schema] messages :: [Method]

Instances

Eq Protocol Source #
Instance details Defined in Language.Avro.Types Methods (==) :: Protocol -> Protocol -> Bool # (/=) :: Protocol -> Protocol -> Bool #
Show Protocol Source #
Instance details Defined in Language.Avro.Types Methods showsPrec :: Int -> Protocol -> ShowS # show :: Protocol -> String # showList :: [Protocol] -> ShowS #
Semigroup Protocol Source #
Instance details Defined in Language.Avro.Types Methods (<>) :: Protocol -> Protocol -> Protocol # sconcat :: NonEmpty Protocol -> Protocol # stimes :: Integral b => b -> Protocol -> Protocol #

type Schema = Type #

An Avro schema is either

A "JSON object in the form {"type":"typeName" ...}
A "JSON string, naming a defined type" (basic type without free variables)
A "JSON array, representing a union"

N.B. It is possible to create a Haskell value (of Schema type) that is not a valid Avro schema by violating one of the above or one of the conditions called out in validateSchema.