Language.Thrift.Types

This module defines types that compose a Thrift IDL file.

Most of the types have an optional srcAnnot parameter that represents a parser-specific source annotation. With trifecta this can hold the Delta. If you do not have need of this, you can use () as the parameter.

Documentation

data Program srcAnnot

A program represents a single Thrift document.

Constructors

Program

Fields

programHeaders :: [Header srcAnnot]

Headers in a document define includes and namespaces.

programDefinitions :: [Definition srcAnnot]

Types and services defined in the document.

Instances

Eq srcAnnot => Eq (Program srcAnnot)

Data srcAnnot => Data (Program srcAnnot)

Ord srcAnnot => Ord (Program srcAnnot)

Show srcAnnot => Show (Program srcAnnot)

Generic (Program srcAnnot)

HasHeaders (Program srcAnnot) [Header srcAnnot]

HasDefinitions (Program srcAnnot) [Definition srcAnnot]

type Rep (Program srcAnnot)

data Header srcAnnot

Headers for a program.

Constructors

HeaderInclude (Include srcAnnot)

Request to include another Thrift file.

HeaderNamespace (Namespace srcAnnot)

A namespace specifier.

Instances

Eq srcAnnot => Eq (Header srcAnnot)

Data srcAnnot => Data (Header srcAnnot)

Ord srcAnnot => Ord (Header srcAnnot)

Show srcAnnot => Show (Header srcAnnot)

Generic (Header srcAnnot)

HasHeaders (Program srcAnnot) [Header srcAnnot]

type Rep (Header srcAnnot)

_Include :: Prism' (Header ann) (Include ann)

_Namespace :: Prism' (Header ann) (Namespace ann)

data Include srcAnnot

The IDL includes another Thrift file.

include "common.thrift"

typedef common.Foo Bar

Constructors

Include

Fields

includePath :: Text

Path to the included file.

includeSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Include srcAnnot)

Data srcAnnot => Data (Include srcAnnot)

Ord srcAnnot => Ord (Include srcAnnot)

Show srcAnnot => Show (Include srcAnnot)

Generic (Include srcAnnot)

HasSrcAnnot (Include srcAnnot) srcAnnot

HasPath (Include srcAnnot) Text

type Rep (Include srcAnnot)

data Namespace srcAnnot

Namespace directives allows control of the namespace or package name used by the generated code for certain languages.

namespace py my_service.generated

Constructors

Namespace

Fields

namespaceLanguage :: Text

The language for which the namespace is being specified. This may be * to refer to all languages.

namespaceName :: Text

Namespace or package path to use in the generated code for that language.

namespaceSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Namespace srcAnnot)

Data srcAnnot => Data (Namespace srcAnnot)

Ord srcAnnot => Ord (Namespace srcAnnot)

Show srcAnnot => Show (Namespace srcAnnot)

Generic (Namespace srcAnnot)

HasName (Namespace srcAnnot) Text

HasSrcAnnot (Namespace srcAnnot) srcAnnot

HasLanguage (Namespace srcAnnot) Text

type Rep (Namespace srcAnnot)

data Definition srcAnnot

A definition either consists of new constants, new types, or new services.

Constructors

ConstDefinition (Const srcAnnot)

A declared constant.

TypeDefinition (Type srcAnnot)

A custom type.

ServiceDefinition (Service srcAnnot)

A service definition.

Instances

Eq srcAnnot => Eq (Definition srcAnnot)

Data srcAnnot => Data (Definition srcAnnot)

Ord srcAnnot => Ord (Definition srcAnnot)

Show srcAnnot => Show (Definition srcAnnot)

Generic (Definition srcAnnot)

HasDefinitions (Program srcAnnot) [Definition srcAnnot]

type Rep (Definition srcAnnot)

_Const :: Prism' (Definition ann) (Const ann)

_Service :: Prism' (Definition ann) (Service ann)

_Type :: Prism' (Definition ann) (Type ann)

data Const srcAnnot

A declared constant.

const i32 code = 1;

Constructors

Const

Fields

constValueType :: TypeReference srcAnnot

Type of the constant.

constName :: Text

Name of the constant.

constValue :: ConstValue srcAnnot

Value of the constant.

constDocstring :: Docstring

Documentation.

constSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Const srcAnnot)

Data srcAnnot => Data (Const srcAnnot)

Ord srcAnnot => Ord (Const srcAnnot)

Show srcAnnot => Show (Const srcAnnot)

Generic (Const srcAnnot)

HasName (Const srcAnnot) Text

HasSrcAnnot (Const srcAnnot) srcAnnot

HasDocstring (Const srcAnnot) Docstring

HasValue (Const srcAnnot) (ConstValue srcAnnot)

HasValueType (Const srcAnnot) (TypeReference srcAnnot)

type Rep (Const srcAnnot)

data Service srcAnnot

A service definition.

service MyService {
    // ...
}

Constructors

Service

Fields

serviceName :: Text

Name of the service.

serviceExtends :: Maybe Text

Name of the service this service extends.

serviceFunctions :: [Function srcAnnot]

All the functions defined for the service.

serviceAnnotations :: [TypeAnnotation]

Annotations added to the service.

serviceDocstring :: Docstring

Documentation.

serviceSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Service srcAnnot)

Data srcAnnot => Data (Service srcAnnot)

Ord srcAnnot => Ord (Service srcAnnot)

Show srcAnnot => Show (Service srcAnnot)

Generic (Service srcAnnot)

HasName (Service srcAnnot) Text

HasSrcAnnot (Service srcAnnot) srcAnnot

HasDocstring (Service srcAnnot) Docstring

HasAnnotations (Service srcAnnot) [TypeAnnotation]

HasFunctions (Service srcAnnot) [Function srcAnnot]

HasExtends (Service srcAnnot) (Maybe Text)

type Rep (Service srcAnnot)

data Type srcAnnot

Defines the various types that can be declared in Thrift.

Constructors

TypedefType (Typedef srcAnnot)

typedef

EnumType (Enum srcAnnot)

enum

StructType (Struct srcAnnot)

struct

UnionType (Union srcAnnot)

union

ExceptionType (Exception srcAnnot)

exception

SenumType (Senum srcAnnot)

senum

Instances

Eq srcAnnot => Eq (Type srcAnnot)

Data srcAnnot => Data (Type srcAnnot)

Ord srcAnnot => Ord (Type srcAnnot)

Show srcAnnot => Show (Type srcAnnot)

Generic (Type srcAnnot)

type Rep (Type srcAnnot)

_Typedef :: Prism' (Type ann) (Typedef ann)

_Enum :: Prism' (Type ann) (Enum ann)

_Struct :: Prism' (Type ann) (Struct ann)

_Union :: Prism' (Type ann) (Union ann)

_Exception :: Prism' (Type ann) (Exception ann)

_Senum :: Prism' (Type ann) (Senum ann)

data Typedef srcAnnot

A typedef is just an alias for another type.

typedef common.Foo Bar

Constructors

Typedef

Fields

typedefTargetType :: TypeReference srcAnnot

The aliased type.

typedefName :: Text

Name of the new type.

typedefAnnotations :: [TypeAnnotation]

Annotations added to the typedef.

typedefDocstring :: Docstring

Documentation.

typedefSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Typedef srcAnnot)

Data srcAnnot => Data (Typedef srcAnnot)

Ord srcAnnot => Ord (Typedef srcAnnot)

Show srcAnnot => Show (Typedef srcAnnot)

Generic (Typedef srcAnnot)

HasName (Typedef srcAnnot) Text

HasSrcAnnot (Typedef srcAnnot) srcAnnot

HasDocstring (Typedef srcAnnot) Docstring

HasAnnotations (Typedef srcAnnot) [TypeAnnotation]

HasTargetType (Typedef srcAnnot) (TypeReference srcAnnot)

type Rep (Typedef srcAnnot)

data Enum srcAnnot

Enums are sets of named integer values.

enum Role {
    User = 1, Admin = 2
}

Constructors

Enum

Fields

enumName :: Text

Name of the enum type.

enumValues :: [EnumDef srcAnnot]

Values defined in the enum.

enumAnnotations :: [TypeAnnotation]

Annotations added to the enum.

enumDocstring :: Docstring

Documentation.

enumSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Enum srcAnnot)

Data srcAnnot => Data (Enum srcAnnot)

Ord srcAnnot => Ord (Enum srcAnnot)

Show srcAnnot => Show (Enum srcAnnot)

Generic (Enum srcAnnot)

HasName (Enum srcAnnot) Text

HasSrcAnnot (Enum srcAnnot) srcAnnot

HasDocstring (Enum srcAnnot) Docstring

HasAnnotations (Enum srcAnnot) [TypeAnnotation]

HasValues (Enum srcAnnot) [EnumDef srcAnnot]

type Rep (Enum srcAnnot)

data Struct srcAnnot

A struct definition

struct User {
    1: Role role = Role.User;
}

Constructors

Struct

Fields

structName :: Text

Name of the struct.

structFields :: [Field srcAnnot]

Fields defined in the struct.

structAnnotations :: [TypeAnnotation]

Annotations added to the struct.

structDocstring :: Docstring

Documentation.

structSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Struct srcAnnot)

Data srcAnnot => Data (Struct srcAnnot)

Ord srcAnnot => Ord (Struct srcAnnot)

Show srcAnnot => Show (Struct srcAnnot)

Generic (Struct srcAnnot)

HasName (Struct srcAnnot) Text

HasSrcAnnot (Struct srcAnnot) srcAnnot

HasDocstring (Struct srcAnnot) Docstring

HasAnnotations (Struct srcAnnot) [TypeAnnotation]

HasFields (Struct srcAnnot) [Field srcAnnot]

type Rep (Struct srcAnnot)

data Union srcAnnot

A union of other types.

union Value {
    1: string stringValue;
    2: i32 intValue;
}

Constructors

Union

Fields

unionName :: Text

Name of the union.

unionFields :: [Field srcAnnot]

Fields defined in the union.

unionAnnotations :: [TypeAnnotation]

Annotations added to the union.

unionDocstring :: Docstring

Documentation.

unionSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Union srcAnnot)

Data srcAnnot => Data (Union srcAnnot)

Ord srcAnnot => Ord (Union srcAnnot)

Show srcAnnot => Show (Union srcAnnot)

Generic (Union srcAnnot)

HasName (Union srcAnnot) Text

HasSrcAnnot (Union srcAnnot) srcAnnot

HasDocstring (Union srcAnnot) Docstring

HasAnnotations (Union srcAnnot) [TypeAnnotation]

HasFields (Union srcAnnot) [Field srcAnnot]

type Rep (Union srcAnnot)

data Exception srcAnnot

Exception types.

exception UserDoesNotExist {
    1: optional string message
    2: required string username
}

Constructors

Exception

Fields

exceptionName :: Text

Name of the exception.

exceptionFields :: [Field srcAnnot]

Fields defined in the exception.

exceptionAnnotations :: [TypeAnnotation]

Annotations added to the exception.

exceptionDocstring :: Docstring

Documentation.

exceptionSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Exception srcAnnot)

Data srcAnnot => Data (Exception srcAnnot)

Ord srcAnnot => Ord (Exception srcAnnot)

Show srcAnnot => Show (Exception srcAnnot)

Generic (Exception srcAnnot)

HasName (Exception srcAnnot) Text

HasSrcAnnot (Exception srcAnnot) srcAnnot

HasDocstring (Exception srcAnnot) Docstring

HasAnnotations (Exception srcAnnot) [TypeAnnotation]

HasFields (Exception srcAnnot) [Field srcAnnot]

type Rep (Exception srcAnnot)

data Senum srcAnnot

An string-only enum. These are a deprecated feature of Thrift and shouldn't be used.

Constructors

Senum

Fields

senumName :: Text

senumValues :: [Text]

senumAnnotations :: [TypeAnnotation]

Annotations added to the senum.

senumDocstring :: Docstring

Documentation.

senumSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Senum srcAnnot)

Data srcAnnot => Data (Senum srcAnnot)

Ord srcAnnot => Ord (Senum srcAnnot)

Show srcAnnot => Show (Senum srcAnnot)

Generic (Senum srcAnnot)

HasName (Senum srcAnnot) Text

HasSrcAnnot (Senum srcAnnot) srcAnnot

HasDocstring (Senum srcAnnot) Docstring

HasAnnotations (Senum srcAnnot) [TypeAnnotation]

HasValues (Senum srcAnnot) [Text]

type Rep (Senum srcAnnot)

data FieldRequiredness

Whether a field is required or optional.

Constructors

Required

The field is required.

Optional

The field is optional.

Instances

Eq FieldRequiredness

Data FieldRequiredness

Ord FieldRequiredness

Show FieldRequiredness

Generic FieldRequiredness

HasRequiredness (Field srcAnnot) (Maybe FieldRequiredness)

type Rep FieldRequiredness

_Required :: Prism' FieldRequiredness ()

_Optional :: Prism' FieldRequiredness ()

data Field srcAnnot

A field inside a struct, exception, or function parameters list.

Constructors

Field

Fields

fieldIdentifier :: Maybe Integer

Position of the field.

While this is optional, it is recommended that Thrift files always contain specific field IDs.

fieldRequiredness :: Maybe FieldRequiredness

Whether this field is required or not.

Behavior may differ between languages if requiredness is not specified. Therefore it's recommended that requiredness for a field is always specified.

fieldValueType :: TypeReference srcAnnot

Type of value the field holds.

fieldName :: Text

Name of the field.

fieldDefaultValue :: Maybe (ConstValue srcAnnot)

Default value of the field, if any.

fieldAnnotations :: [TypeAnnotation]

Field annotations.

fieldDocstring :: Docstring

Documentation.

fieldSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Field srcAnnot)

Data srcAnnot => Data (Field srcAnnot)

Ord srcAnnot => Ord (Field srcAnnot)

Show srcAnnot => Show (Field srcAnnot)

Generic (Field srcAnnot)

HasName (Field srcAnnot) Text

HasSrcAnnot (Field srcAnnot) srcAnnot

HasDocstring (Field srcAnnot) Docstring

HasValueType (Field srcAnnot) (TypeReference srcAnnot)

HasRequiredness (Field srcAnnot) (Maybe FieldRequiredness)

HasIdentifier (Field srcAnnot) (Maybe Integer)

HasDefaultValue (Field srcAnnot) (Maybe (ConstValue srcAnnot))

HasAnnotations (Field srcAnnot) [TypeAnnotation]

HasParameters (Function srcAnnot) [Field srcAnnot]

HasExceptions (Function srcAnnot) (Maybe [Field srcAnnot])

HasFields (Struct srcAnnot) [Field srcAnnot]

HasFields (Union srcAnnot) [Field srcAnnot]

HasFields (Exception srcAnnot) [Field srcAnnot]

type Rep (Field srcAnnot)

data EnumDef srcAnnot

A named value inside an enum.

Constructors

EnumDef

Fields

enumDefName :: Text

Name of the value.

enumDefValue :: Maybe Integer

Value attached to the enum for that name.

enumDefAnnotations :: [TypeAnnotation]

Annotations added to this enum field.

enumDefDocstring :: Docstring

Documentation

enumDefSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (EnumDef srcAnnot)

Data srcAnnot => Data (EnumDef srcAnnot)

Ord srcAnnot => Ord (EnumDef srcAnnot)

Show srcAnnot => Show (EnumDef srcAnnot)

Generic (EnumDef srcAnnot)

HasName (EnumDef srcAnnot) Text

HasSrcAnnot (EnumDef srcAnnot) srcAnnot

HasDocstring (EnumDef srcAnnot) Docstring

HasValue (EnumDef srcAnnot) (Maybe Integer)

HasAnnotations (EnumDef srcAnnot) [TypeAnnotation]

HasValues (Enum srcAnnot) [EnumDef srcAnnot]

type Rep (EnumDef srcAnnot)

data ConstValue srcAnnot

A constant literal value in the IDL. Only a few basic types, lists, and maps can be presented in Thrift files as literals.

Constants are used for IDL-level constants and default values for fields.

Constructors

ConstInt Integer

An integer. 42

ConstFloat Double

A float. 4.2

ConstLiteral Text

A literal string. "hello"

ConstIdentifier Text srcAnnot

A reference to another constant. Foo.bar

ConstList [ConstValue srcAnnot]

A literal list containing other constant values. [42]

ConstMap [(ConstValue srcAnnot, ConstValue srcAnnot)]

A literal list containing other constant values. {"hellO": 1, "world": 2}

Instances

Eq srcAnnot => Eq (ConstValue srcAnnot)

Data srcAnnot => Data (ConstValue srcAnnot)

Ord srcAnnot => Ord (ConstValue srcAnnot)

Show srcAnnot => Show (ConstValue srcAnnot)

Generic (ConstValue srcAnnot)

HasValue (Const srcAnnot) (ConstValue srcAnnot)

HasDefaultValue (Field srcAnnot) (Maybe (ConstValue srcAnnot))

type Rep (ConstValue srcAnnot)

_ConstInt :: forall srcAnnot. Prism' (ConstValue srcAnnot) Integer

_ConstFloat :: forall srcAnnot. Prism' (ConstValue srcAnnot) Double

_ConstLiteral :: forall srcAnnot. Prism' (ConstValue srcAnnot) Text

_ConstIdentifier :: forall srcAnnot. Prism' (ConstValue srcAnnot) (Text, srcAnnot)

_ConstList :: forall srcAnnot. Prism' (ConstValue srcAnnot) [ConstValue srcAnnot]

_ConstMap :: forall srcAnnot. Prism' (ConstValue srcAnnot) [(ConstValue srcAnnot, ConstValue srcAnnot)]

data TypeReference srcAnnot

A reference to a type.

Constructors

DefinedType Text srcAnnot

A custom defined type referred to by name.

StringType [TypeAnnotation]

string and annotations.

BinaryType [TypeAnnotation]

binary and annotations.

SListType [TypeAnnotation]

slist and annotations.

BoolType [TypeAnnotation]

bool and annotations.

ByteType [TypeAnnotation]

byte and annotations.

I16Type [TypeAnnotation]

i16 and annotations.

I32Type [TypeAnnotation]

i32 and annotations.

I64Type [TypeAnnotation]

i64 and annotations.

DoubleType [TypeAnnotation]

double and annotations.

MapType (TypeReference srcAnnot) (TypeReference srcAnnot) [TypeAnnotation]

map<foo, bar> and annotations.

SetType (TypeReference srcAnnot) [TypeAnnotation]

set<baz> and annotations.

ListType (TypeReference srcAnnot) [TypeAnnotation]

list<qux> and annotations.

Instances

Eq srcAnnot => Eq (TypeReference srcAnnot)

Data srcAnnot => Data (TypeReference srcAnnot)

Ord srcAnnot => Ord (TypeReference srcAnnot)

Show srcAnnot => Show (TypeReference srcAnnot)

Generic (TypeReference srcAnnot)

HasValueType (Field srcAnnot) (TypeReference srcAnnot)

HasValueType (Const srcAnnot) (TypeReference srcAnnot)

HasReturnType (Function srcAnnot) (Maybe (TypeReference srcAnnot))

HasTargetType (Typedef srcAnnot) (TypeReference srcAnnot)

type Rep (TypeReference srcAnnot)

_DefinedType :: forall srcAnnot. Prism' (TypeReference srcAnnot) (Text, srcAnnot)

_StringType :: forall srcAnnot. Prism' (TypeReference srcAnnot) [TypeAnnotation]

_BinaryType :: forall srcAnnot. Prism' (TypeReference srcAnnot) [TypeAnnotation]

_SListType :: forall srcAnnot. Prism' (TypeReference srcAnnot) [TypeAnnotation]

_BoolType :: forall srcAnnot. Prism' (TypeReference srcAnnot) [TypeAnnotation]

_ByteType :: forall srcAnnot. Prism' (TypeReference srcAnnot) [TypeAnnotation]

_I16Type :: forall srcAnnot. Prism' (TypeReference srcAnnot) [TypeAnnotation]

_I32Type :: forall srcAnnot. Prism' (TypeReference srcAnnot) [TypeAnnotation]

_I64Type :: forall srcAnnot. Prism' (TypeReference srcAnnot) [TypeAnnotation]

_DoubleType :: forall srcAnnot. Prism' (TypeReference srcAnnot) [TypeAnnotation]

_MapType :: forall srcAnnot. Prism' (TypeReference srcAnnot) (TypeReference srcAnnot, TypeReference srcAnnot, [TypeAnnotation])

_SetType :: forall srcAnnot. Prism' (TypeReference srcAnnot) (TypeReference srcAnnot, [TypeAnnotation])

_ListType :: forall srcAnnot. Prism' (TypeReference srcAnnot) (TypeReference srcAnnot, [TypeAnnotation])

data Function srcAnnot

A function defined inside a service.

Constructors

Function

Fields

functionOneWay :: Bool

Whether the function is oneway. If it's one way, it cannot receive repsonses.

functionReturnType :: Maybe (TypeReference srcAnnot)

Return type of the function, or Nothing if it's void or oneway.

functionName :: Text

Name of the function.

functionParameters :: [Field srcAnnot]

Parameters accepted by the function.

functionExceptions :: Maybe [Field srcAnnot]

Exceptions raised by the function, if any.

functionAnnotations :: [TypeAnnotation]

Annotations added to the function.

functionDocstring :: Docstring

Documentation.

functionSrcAnnot :: srcAnnot

Instances

Eq srcAnnot => Eq (Function srcAnnot)

Data srcAnnot => Data (Function srcAnnot)

Ord srcAnnot => Ord (Function srcAnnot)

Show srcAnnot => Show (Function srcAnnot)

Generic (Function srcAnnot)

HasName (Function srcAnnot) Text

HasSrcAnnot (Function srcAnnot) srcAnnot

HasDocstring (Function srcAnnot) Docstring

HasOneWay (Function srcAnnot) Bool

HasAnnotations (Function srcAnnot) [TypeAnnotation]

HasReturnType (Function srcAnnot) (Maybe (TypeReference srcAnnot))

HasParameters (Function srcAnnot) [Field srcAnnot]

HasExceptions (Function srcAnnot) (Maybe [Field srcAnnot])

HasFunctions (Service srcAnnot) [Function srcAnnot]

type Rep (Function srcAnnot)

data TypeAnnotation

Type annoations may be added in various places in the form,

(foo = "bar", baz, qux = "quux")

These do not usually affect code generation but allow for custom logic if writing your own code generator.

Constructors

TypeAnnotation

Fields

typeAnnotationName :: Text

Name of the annotation.

typeAnnotationValue :: Maybe Text

Value for the annotation.

Instances

Eq TypeAnnotation

Data TypeAnnotation

Ord TypeAnnotation

Show TypeAnnotation

Generic TypeAnnotation

HasName TypeAnnotation Text

HasValue TypeAnnotation (Maybe Text)

HasAnnotations (Field srcAnnot) [TypeAnnotation]

HasAnnotations (Function srcAnnot) [TypeAnnotation]

HasAnnotations (Service srcAnnot) [TypeAnnotation]

HasAnnotations (Typedef srcAnnot) [TypeAnnotation]

HasAnnotations (EnumDef srcAnnot) [TypeAnnotation]

HasAnnotations (Enum srcAnnot) [TypeAnnotation]

HasAnnotations (Struct srcAnnot) [TypeAnnotation]

HasAnnotations (Union srcAnnot) [TypeAnnotation]

HasAnnotations (Exception srcAnnot) [TypeAnnotation]

HasAnnotations (Senum srcAnnot) [TypeAnnotation]

type Rep TypeAnnotation

type Docstring = Maybe Text

Docstrings are Javadoc-style comments attached various defined objects.

/**
 * Fetches an item.
 */
Item getItem()

class HasAnnotations s a | s -> a where

Methods

annotations :: Lens' s a

Instances

HasAnnotations (Field srcAnnot) [TypeAnnotation]

HasAnnotations (Function srcAnnot) [TypeAnnotation]

HasAnnotations (Service srcAnnot) [TypeAnnotation]

HasAnnotations (Typedef srcAnnot) [TypeAnnotation]

HasAnnotations (EnumDef srcAnnot) [TypeAnnotation]

HasAnnotations (Enum srcAnnot) [TypeAnnotation]

HasAnnotations (Struct srcAnnot) [TypeAnnotation]

HasAnnotations (Union srcAnnot) [TypeAnnotation]

HasAnnotations (Exception srcAnnot) [TypeAnnotation]

HasAnnotations (Senum srcAnnot) [TypeAnnotation]

class HasDefaultValue s a | s -> a where

Methods

defaultValue :: Lens' s a

Instances

HasDefaultValue (Field srcAnnot) (Maybe (ConstValue srcAnnot))

class HasDefinitions s a | s -> a where

Methods

definitions :: Lens' s a

Instances

HasDefinitions (Program srcAnnot) [Definition srcAnnot]

class HasDocstring s a | s -> a where

Methods

docstring :: Lens' s a

Instances

HasDocstring (Field srcAnnot) Docstring

HasDocstring (Function srcAnnot) Docstring

HasDocstring (Service srcAnnot) Docstring

HasDocstring (Const srcAnnot) Docstring

HasDocstring (Typedef srcAnnot) Docstring

HasDocstring (EnumDef srcAnnot) Docstring

HasDocstring (Enum srcAnnot) Docstring

HasDocstring (Struct srcAnnot) Docstring

HasDocstring (Union srcAnnot) Docstring

HasDocstring (Exception srcAnnot) Docstring

HasDocstring (Senum srcAnnot) Docstring

class HasExceptions s a | s -> a where

Methods

exceptions :: Lens' s a

Instances

HasExceptions (Function srcAnnot) (Maybe [Field srcAnnot])

class HasExtends s a | s -> a where

Methods

extends :: Lens' s a

Instances

HasExtends (Service srcAnnot) (Maybe Text)

class HasFields s a | s -> a where

Methods

fields :: Lens' s a

Instances

HasFields (Struct srcAnnot) [Field srcAnnot]

HasFields (Union srcAnnot) [Field srcAnnot]

HasFields (Exception srcAnnot) [Field srcAnnot]

class HasFunctions s a | s -> a where

Methods

functions :: Lens' s a

Instances

HasFunctions (Service srcAnnot) [Function srcAnnot]

class HasHeaders s a | s -> a where

Methods

headers :: Lens' s a

Instances

HasHeaders (Program srcAnnot) [Header srcAnnot]

class HasIdentifier s a | s -> a where

Methods

identifier :: Lens' s a

Instances

HasIdentifier (Field srcAnnot) (Maybe Integer)

class HasLanguage s a | s -> a where

Methods

language :: Lens' s a

Instances

HasLanguage (Namespace srcAnnot) Text

class HasName s a | s -> a where

Methods

name :: Lens' s a

Instances

HasName TypeAnnotation Text

HasName (Field srcAnnot) Text

HasName (Function srcAnnot) Text

HasName (Service srcAnnot) Text

HasName (Const srcAnnot) Text

HasName (Typedef srcAnnot) Text

HasName (EnumDef srcAnnot) Text

HasName (Enum srcAnnot) Text

HasName (Struct srcAnnot) Text

HasName (Union srcAnnot) Text

HasName (Exception srcAnnot) Text

HasName (Senum srcAnnot) Text

HasName (Namespace srcAnnot) Text

class HasOneWay s a | s -> a where

Methods

oneWay :: Lens' s a

Instances

HasOneWay (Function srcAnnot) Bool

class HasParameters s a | s -> a where

Methods

parameters :: Lens' s a

Instances

HasParameters (Function srcAnnot) [Field srcAnnot]

class HasPath s a | s -> a where

Methods

path :: Lens' s a

Instances

HasPath (Include srcAnnot) Text

class HasRequiredness s a | s -> a where

Methods

requiredness :: Lens' s a

Instances

HasRequiredness (Field srcAnnot) (Maybe FieldRequiredness)

class HasReturnType s a | s -> a where

Methods

returnType :: Lens' s a

Instances

HasReturnType (Function srcAnnot) (Maybe (TypeReference srcAnnot))

class HasSrcAnnot s a | s -> a where

Methods

srcAnnot :: Lens' s a

Instances

HasSrcAnnot (Field srcAnnot) srcAnnot

HasSrcAnnot (Function srcAnnot) srcAnnot

HasSrcAnnot (Service srcAnnot) srcAnnot

HasSrcAnnot (Const srcAnnot) srcAnnot

HasSrcAnnot (Typedef srcAnnot) srcAnnot

HasSrcAnnot (EnumDef srcAnnot) srcAnnot

HasSrcAnnot (Enum srcAnnot) srcAnnot

HasSrcAnnot (Struct srcAnnot) srcAnnot

HasSrcAnnot (Union srcAnnot) srcAnnot

HasSrcAnnot (Exception srcAnnot) srcAnnot

HasSrcAnnot (Senum srcAnnot) srcAnnot

HasSrcAnnot (Namespace srcAnnot) srcAnnot

HasSrcAnnot (Include srcAnnot) srcAnnot

class HasTargetType s a | s -> a where

Methods

targetType :: Lens' s a

Instances

HasTargetType (Typedef srcAnnot) (TypeReference srcAnnot)

class HasValue s a | s -> a where

Methods

value :: Lens' s a

Instances

HasValue TypeAnnotation (Maybe Text)

HasValue (Const srcAnnot) (ConstValue srcAnnot)

HasValue (EnumDef srcAnnot) (Maybe Integer)

class HasValues s a | s -> a where

Methods

values :: Lens' s a

Instances

HasValues (Enum srcAnnot) [EnumDef srcAnnot]

HasValues (Senum srcAnnot) [Text]

class HasValueType s a | s -> a where

Methods

valueType :: Lens' s a

Instances

HasValueType (Field srcAnnot) (TypeReference srcAnnot)

HasValueType (Const srcAnnot) (TypeReference srcAnnot)