Safe Haskell	None
Language	Haskell98

Text.DescriptorProtos.Options

Description

This module provides a less verbose API for accessing the options of the various descriptor messages types. There are seven different option types. The EnumValueOptions are not currently settable in the proto file. To access extension keys the descendKey functions are provided as the descend functions ignore them. The toDP, toEP, toSP are type-specific descents that are demonstrated in the the tests below. They are useful in that they provide more information for the type-checker. The toFP, toEVP, and toMP are fully type-specific descents but are needed to make the tests below type-check, though they could have been used in test4, test5', and test7.

import Text.DescriptorProtos.Options
import Text.DescriptorProtos(fileDescriptorProto)

test1 :: D.FileOptions
test1 = options fileDescriptorProto

test2 :: Maybe D.MessageOptions
test2 = return fileDescriptorProto >>= descend "FieldDescriptorProto" >>= return . options

test3 :: Maybe D.EnumOptions
test3 = return fileDescriptorProto >>= toDP "FieldDescriptorProto" >>= descend "Type" >>= return . options

test4 :: Maybe D.EnumValueOptions
test4 = return fileDescriptorProto >>= toDP "FieldDescriptorProto" >>= toEP "Type" >>= descend "TYPE_DOUBLE" >>= return . options

test5 :: Maybe D.FieldOptions
test5 = return fileDescriptorProto >>= toDP "DescriptorProto" >>= toDP "ExtensionRange" >>= descend "start" >>= return . options

test6 :: Maybe D.ServiceOptions
test6 = return fileDescriptorProto >>= descend "ImaginaryService" >>= return . options

test7 :: Maybe D.MethodOptions
test7 = return fileDescriptorProto >>= toSP "ImaginaryService" >>= descend "ImaginaryMethod" >>= return . options

Documentation

descend :: DescendClass a c => String -> a -> Maybe c Source

descendKey :: DescendKey a => String -> a -> Maybe FieldDescriptorProto Source

toDP :: DescendClass a DescriptorProto => String -> a -> Maybe DescriptorProto Source

toEP :: DescendClass a EnumDescriptorProto => String -> a -> Maybe EnumDescriptorProto Source

toSP :: String -> FileDescriptorProto -> Maybe ServiceDescriptorProto Source

toFP :: String -> DescriptorProto -> Maybe FieldDescriptorProto Source

toEVP :: String -> EnumDescriptorProto -> Maybe EnumValueDescriptorProto Source

toMP :: String -> ServiceDescriptorProto -> Maybe MethodDescriptorProto Source

class NameAndOptions a opt | a -> opt, opt -> a where Source

Methods

name :: a -> Utf8 Source

options :: a -> opt Source

class DescendKey a where Source

Methods

descendKey' :: a -> Utf8 -> Maybe FieldDescriptorProto Source

Instances

DescendKey DescriptorProto Source
DescendKey FileDescriptorProto Source

NameAndOptions MethodDescriptorProto MethodOptions Source
NameAndOptions ServiceDescriptorProto ServiceOptions Source
NameAndOptions FieldDescriptorProto FieldOptions Source
NameAndOptions EnumValueDescriptorProto EnumValueOptions Source
NameAndOptions EnumDescriptorProto EnumOptions Source
NameAndOptions DescriptorProto MessageOptions Source
NameAndOptions FileDescriptorProto FileOptions Source

DescendClass ServiceDescriptorProto MethodDescriptorProto Source
DescendClass EnumDescriptorProto EnumValueDescriptorProto Source
DescendClass DescriptorProto FieldDescriptorProto Source
DescendClass DescriptorProto EnumDescriptorProto Source
DescendClass DescriptorProto DescriptorProto Source
DescendClass FileDescriptorProto ServiceDescriptorProto Source
DescendClass FileDescriptorProto EnumDescriptorProto Source
DescendClass FileDescriptorProto DescriptorProto Source

Eq FileDescriptorProto Source
Data FileDescriptorProto Source
Ord FileDescriptorProto Source
Show FileDescriptorProto Source
UnknownMessage FileDescriptorProto Source
GPB FileDescriptorProto Source
Wire FileDescriptorProto Source
TextMsg FileDescriptorProto Source
TextType FileDescriptorProto Source
ReflectDescriptor FileDescriptorProto Source
Mergeable FileDescriptorProto Source
Default FileDescriptorProto Source
DescendKey FileDescriptorProto Source
NameAndOptions FileDescriptorProto FileOptions Source
DescendClass FileDescriptorProto ServiceDescriptorProto Source
DescendClass FileDescriptorProto EnumDescriptorProto Source
DescendClass FileDescriptorProto DescriptorProto Source
MessageAPI msg' (msg' -> FileDescriptorProto) FileDescriptorProto Source

Eq DescriptorProto Source
Data DescriptorProto Source
Ord DescriptorProto Source
Show DescriptorProto Source
UnknownMessage DescriptorProto Source
GPB DescriptorProto Source
Wire DescriptorProto Source
TextMsg DescriptorProto Source
TextType DescriptorProto Source
ReflectDescriptor DescriptorProto Source
Mergeable DescriptorProto Source
Default DescriptorProto Source
DescendKey DescriptorProto Source
NameAndOptions DescriptorProto MessageOptions Source
DescendClass DescriptorProto FieldDescriptorProto Source
DescendClass DescriptorProto EnumDescriptorProto Source
DescendClass DescriptorProto DescriptorProto Source
DescendClass FileDescriptorProto DescriptorProto Source
MessageAPI msg' (msg' -> DescriptorProto) DescriptorProto Source

Eq EnumDescriptorProto Source
Data EnumDescriptorProto Source
Ord EnumDescriptorProto Source
Show EnumDescriptorProto Source
UnknownMessage EnumDescriptorProto Source
GPB EnumDescriptorProto Source
Wire EnumDescriptorProto Source
TextMsg EnumDescriptorProto Source
TextType EnumDescriptorProto Source
ReflectDescriptor EnumDescriptorProto Source
Mergeable EnumDescriptorProto Source
Default EnumDescriptorProto Source
NameAndOptions EnumDescriptorProto EnumOptions Source
DescendClass EnumDescriptorProto EnumValueDescriptorProto Source
DescendClass DescriptorProto EnumDescriptorProto Source
DescendClass FileDescriptorProto EnumDescriptorProto Source
MessageAPI msg' (msg' -> EnumDescriptorProto) EnumDescriptorProto Source

Eq EnumValueDescriptorProto Source
Data EnumValueDescriptorProto Source
Ord EnumValueDescriptorProto Source
Show EnumValueDescriptorProto Source
UnknownMessage EnumValueDescriptorProto Source
GPB EnumValueDescriptorProto Source
Wire EnumValueDescriptorProto Source
TextMsg EnumValueDescriptorProto Source
TextType EnumValueDescriptorProto Source
ReflectDescriptor EnumValueDescriptorProto Source
Mergeable EnumValueDescriptorProto Source
Default EnumValueDescriptorProto Source
NameAndOptions EnumValueDescriptorProto EnumValueOptions Source
DescendClass EnumDescriptorProto EnumValueDescriptorProto Source
MessageAPI msg' (msg' -> EnumValueDescriptorProto) EnumValueDescriptorProto Source

Eq FieldDescriptorProto Source
Data FieldDescriptorProto Source
Ord FieldDescriptorProto Source
Show FieldDescriptorProto Source
UnknownMessage FieldDescriptorProto Source
GPB FieldDescriptorProto Source
Wire FieldDescriptorProto Source
TextMsg FieldDescriptorProto Source
TextType FieldDescriptorProto Source
ReflectDescriptor FieldDescriptorProto Source
Mergeable FieldDescriptorProto Source
Default FieldDescriptorProto Source
NameAndOptions FieldDescriptorProto FieldOptions Source
DescendClass DescriptorProto FieldDescriptorProto Source
MessageAPI msg' (msg' -> FieldDescriptorProto) FieldDescriptorProto Source

Eq ServiceDescriptorProto Source
Data ServiceDescriptorProto Source
Ord ServiceDescriptorProto Source
Show ServiceDescriptorProto Source
UnknownMessage ServiceDescriptorProto Source
GPB ServiceDescriptorProto Source
Wire ServiceDescriptorProto Source
TextMsg ServiceDescriptorProto Source
TextType ServiceDescriptorProto Source
ReflectDescriptor ServiceDescriptorProto Source
Mergeable ServiceDescriptorProto Source
Default ServiceDescriptorProto Source
NameAndOptions ServiceDescriptorProto ServiceOptions Source
DescendClass ServiceDescriptorProto MethodDescriptorProto Source
DescendClass FileDescriptorProto ServiceDescriptorProto Source
MessageAPI msg' (msg' -> ServiceDescriptorProto) ServiceDescriptorProto Source

Eq MethodDescriptorProto Source
Data MethodDescriptorProto Source
Ord MethodDescriptorProto Source
Show MethodDescriptorProto Source
UnknownMessage MethodDescriptorProto Source
GPB MethodDescriptorProto Source
Wire MethodDescriptorProto Source
TextMsg MethodDescriptorProto Source
TextType MethodDescriptorProto Source
ReflectDescriptor MethodDescriptorProto Source
Mergeable MethodDescriptorProto Source
Default MethodDescriptorProto Source
NameAndOptions MethodDescriptorProto MethodOptions Source
DescendClass ServiceDescriptorProto MethodDescriptorProto Source
MessageAPI msg' (msg' -> MethodDescriptorProto) MethodDescriptorProto Source

Eq EnumOptions Source
Data EnumOptions Source
Ord EnumOptions Source
Show EnumOptions Source
UnknownMessage EnumOptions Source
ExtendMessage EnumOptions Source
GPB EnumOptions Source
Wire EnumOptions Source
TextMsg EnumOptions Source
TextType EnumOptions Source
ReflectDescriptor EnumOptions Source
Mergeable EnumOptions Source
Default EnumOptions Source
NameAndOptions EnumDescriptorProto EnumOptions Source
MessageAPI msg' (msg' -> EnumOptions) EnumOptions Source

Eq EnumValueOptions Source
Data EnumValueOptions Source
Ord EnumValueOptions Source
Show EnumValueOptions Source
UnknownMessage EnumValueOptions Source
ExtendMessage EnumValueOptions Source
GPB EnumValueOptions Source
Wire EnumValueOptions Source
TextMsg EnumValueOptions Source
TextType EnumValueOptions Source
ReflectDescriptor EnumValueOptions Source
Mergeable EnumValueOptions Source
Default EnumValueOptions Source
NameAndOptions EnumValueDescriptorProto EnumValueOptions Source
MessageAPI msg' (msg' -> EnumValueOptions) EnumValueOptions Source

Eq FieldOptions Source
Data FieldOptions Source
Ord FieldOptions Source
Show FieldOptions Source
UnknownMessage FieldOptions Source
ExtendMessage FieldOptions Source
GPB FieldOptions Source
Wire FieldOptions Source
TextMsg FieldOptions Source
TextType FieldOptions Source
ReflectDescriptor FieldOptions Source
Mergeable FieldOptions Source
Default FieldOptions Source
NameAndOptions FieldDescriptorProto FieldOptions Source
MessageAPI msg' (msg' -> FieldOptions) FieldOptions Source

Eq FileOptions Source
Data FileOptions Source
Ord FileOptions Source
Show FileOptions Source
UnknownMessage FileOptions Source
ExtendMessage FileOptions Source
GPB FileOptions Source
Wire FileOptions Source
TextMsg FileOptions Source
TextType FileOptions Source
ReflectDescriptor FileOptions Source
Mergeable FileOptions Source
Default FileOptions Source
NameAndOptions FileDescriptorProto FileOptions Source
MessageAPI msg' (msg' -> FileOptions) FileOptions Source

Eq MessageOptions Source
Data MessageOptions Source
Ord MessageOptions Source
Show MessageOptions Source
UnknownMessage MessageOptions Source
ExtendMessage MessageOptions Source
GPB MessageOptions Source
Wire MessageOptions Source
TextMsg MessageOptions Source
TextType MessageOptions Source
ReflectDescriptor MessageOptions Source
Mergeable MessageOptions Source
Default MessageOptions Source
NameAndOptions DescriptorProto MessageOptions Source
MessageAPI msg' (msg' -> MessageOptions) MessageOptions Source

Eq MethodOptions Source
Data MethodOptions Source
Ord MethodOptions Source
Show MethodOptions Source
UnknownMessage MethodOptions Source
ExtendMessage MethodOptions Source
GPB MethodOptions Source
Wire MethodOptions Source
TextMsg MethodOptions Source
TextType MethodOptions Source
ReflectDescriptor MethodOptions Source
Mergeable MethodOptions Source
Default MethodOptions Source
NameAndOptions MethodDescriptorProto MethodOptions Source
MessageAPI msg' (msg' -> MethodOptions) MethodOptions Source

Eq ServiceOptions Source
Data ServiceOptions Source
Ord ServiceOptions Source
Show ServiceOptions Source
UnknownMessage ServiceOptions Source
ExtendMessage ServiceOptions Source
GPB ServiceOptions Source
Wire ServiceOptions Source
TextMsg ServiceOptions Source
TextType ServiceOptions Source
ReflectDescriptor ServiceOptions Source
Mergeable ServiceOptions Source
Default ServiceOptions Source
NameAndOptions ServiceDescriptorProto ServiceOptions Source
MessageAPI msg' (msg' -> ServiceOptions) ServiceOptions Source