Environment.hs

-- Note: this is an automatically generated file. Do not edit.

-- | Type definitions for the Avro code generation environment

module Hydra.Avro.Environment where

import qualified Hydra.Avro.Schema as Schema
import qualified Hydra.Coders as Coders
import qualified Hydra.Core as Core
import qualified Hydra.Json.Model as Model
import Prelude hiding  (Enum, Ordering, decodeFloat, encodeFloat, fail, map, pure, sum)
import qualified Data.Scientific as Sci
import qualified Data.Map as M

-- | An Avro qualified name with optional namespace
data AvroQualifiedName =
  AvroQualifiedName {
    -- | The optional namespace
    avroQualifiedNameNamespace :: (Maybe String),
    -- | The local name
    avroQualifiedNameName :: String}
  deriving (Eq, Ord, Read, Show)

_AvroQualifiedName = Core.Name "hydra.avro.environment.AvroQualifiedName"

_AvroQualifiedName_namespace = Core.Name "namespace"

_AvroQualifiedName_name = Core.Name "name"

-- | An Avro foreign key annotation linking a field to another type
data AvroForeignKey =
  AvroForeignKey {
    -- | The Hydra type name referenced by this foreign key
    avroForeignKeyTypeName :: Core.Name,
    -- | A function which constructs element names from string values
    avroForeignKeyConstructor :: (String -> Core.Name)}

_AvroForeignKey = Core.Name "hydra.avro.environment.AvroForeignKey"

_AvroForeignKey_typeName = Core.Name "typeName"

_AvroForeignKey_constructor = Core.Name "constructor"

-- | An Avro primary key annotation identifying the element name field
data AvroPrimaryKey =
  AvroPrimaryKey {
    -- | The name of the primary key field
    avroPrimaryKeyFieldName :: Core.Name,
    -- | A function which constructs element names from string values
    avroPrimaryKeyConstructor :: (String -> Core.Name)}

_AvroPrimaryKey = Core.Name "hydra.avro.environment.AvroPrimaryKey"

_AvroPrimaryKey_fieldName = Core.Name "fieldName"

_AvroPrimaryKey_constructor = Core.Name "constructor"

-- | Environment for Avro-to-Hydra code generation
data AvroEnvironment =
  AvroEnvironment {
    -- | Named adapters for previously processed schemas
    avroEnvironmentNamedAdapters :: (M.Map AvroQualifiedName (Coders.Adapter Schema.Schema Core.Type Model.Value Core.Term)),
    -- | The current Avro namespace
    avroEnvironmentNamespace :: (Maybe String),
    -- | Generated Hydra elements
    avroEnvironmentElements :: (M.Map Core.Name Core.Binding)}

_AvroEnvironment = Core.Name "hydra.avro.environment.AvroEnvironment"

_AvroEnvironment_namedAdapters = Core.Name "namedAdapters"

_AvroEnvironment_namespace = Core.Name "namespace"

_AvroEnvironment_elements = Core.Name "elements"

-- | Environment for Hydra-to-Avro encoding, tracking which named types have been emitted
data EncodeEnvironment =
  EncodeEnvironment {
    -- | All named types available for reference
    encodeEnvironmentTypeMap :: (M.Map Core.Name Core.Type),
    -- | Adapters for types that have already been fully emitted (emit references for these)
    encodeEnvironmentEmitted :: (M.Map Core.Name (Coders.Adapter Core.Type Schema.Schema Core.Term Model.Value))}

_EncodeEnvironment = Core.Name "hydra.avro.environment.EncodeEnvironment"

_EncodeEnvironment_typeMap = Core.Name "typeMap"

_EncodeEnvironment_emitted = Core.Name "emitted"