Text.ProtocolBuffers.Extensions

The Extensions module contributes two main things. The first is the definition and implementation of extensible message features. This means that the ExtField data type is exported but its constructor is (in an ideal world) hidden.

This first part also includes the keys for the extension fields: the Key data type. These are typically defined in code generated by hprotoc from '.proto' file definitions.

The second main part is the MessageAPI class which defines getVal and isSet. These allow uniform access to normal and extension fields for users.

Access to extension fields is strictly though keys. There is not currently any way to query or change or clear any other extension field data.

This module is likely to get broken up into pieces.

Query functions for Key

getKeyFieldId :: Key c msg v -> FieldId

This allows reflection, in this case it gives the numerical FieldId of the key, from 1 to 2^29-1 (excluding 19,000 through 19,999).

getKeyFieldType :: Key c msg v -> FieldType

This allows reflection, in this case it gives the FieldType enumeration value (1 to 18) of the Text.DescriptorProtos.FieldDescriptorProto.Type of the field.

getKeyDefaultValue :: Key c msg v -> v

This will return the default value for a given Key, which is set in the '.proto' file, or if unset it is the defaultValue of that type.

External types and classes

data Key c msg v where

The Key data type is used with the ExtKey class to put, get, and clear external fields of messages. The Key can also be used with the MessagesAPI to get a possibly default value and to check whether a key has been set in a message.

The Key type (opaque to the user) has a phantom type of Maybe or Seq that corresponds to Optional or Repeated fields. And a second phantom type that matches the message type it must be used with. The third type parameter corresonds to the Haskell value type.

The Key is a GADT that puts all the needed class instances into scope. The actual content is the FieldId ( numeric key), the FieldType (for sanity checks), and Maybe v (a non-standard default value).

When code is generated all of the known keys are taken into account in the deserialization from the wire. Unknown extension fields are read as a collection of raw byte sequences. If a key is then presented it will be used to parse the bytes.

There is no guarantee for what happens if two Keys disagree about the type of a field; in particular there may be undefined values and runtime errors. The data constructor for Key has to be exported to the generated code, but is not exposed to the user by Text.ProtocolBuffers.

Constructors

Key :: (ExtKey c, ExtendMessage msg, GPB v) => FieldId -> FieldType -> Maybe v -> Key c msg v

Instances

Default v => MessageAPI msg (Key Maybe msg v) v

Default v => MessageAPI msg (Key Seq msg v) (Seq v)

Typeable1 c => Typeable2 (Key c)

(Typeable1 c, Typeable msg, Typeable v) => Show (Key c msg v)

class ExtKey c where

The ExtKey class has three functions for user of the API: putExt, getExt, and clearExt. The wireGetKey is used in generated code.

There are two instances of this class, Maybe for optional message fields and Seq for repeated message fields. This class allows for uniform treatment of these two kinds of extension fields.

Methods

putExt :: Key c msg v -> c v -> msg -> msg

Change or clear the value of a key in a message. Passing Nothing with an optional key or an empty Seq with a repeated key clears the value. This function thus maintains the invariant that having a field number in the ExtField map means that the field is set and not empty.

This should be only way to set the contents of a extension field.

getExt :: Key c msg v -> msg -> Either String (c v)

Access the key in the message. Optional have type (Key Maybe msg v) and return type (Maybe v) while repeated fields have type (Key Seq msg v) and return type (Seq v).

There are a few sources of errors with the lookup of the key:

• It may find unparsed bytes from loading the message. getExt will attempt to parse the bytes as the key's value type, and may fail. The parsing is done with the parseWireExt method (which is not exported to user API).
• The wrong optional-key versus repeated-key type is a failure
• The wrong type of the value might be found in the map and * cause a failure

The failures above should only happen if two different keys are used with the same field number.

clearExt :: Key c msg v -> msg -> msg

wireGetKey :: Key c msg v -> msg -> Get msg

Instances

ExtKey Maybe

ExtKey Seq

ExtKey PackedSeq

class MessageAPI msg a b | msg a -> b where

Methods

getVal :: msg -> a -> b

Access data in a message. The first argument is always the message. The second argument can be one of 4 categories.

• The field name of a required field acts a simple retrieval of the data from the message.
• The field name of an optional field will retreive the data if it is set or lookup the default value if it is not set.
• The field name of a repeated field always retrieves the (possibly empty) Seq of values.
• A Key for an optional or repeated value will act as the field name does above, but if there is a type mismatch or parse error it will use the defaultValue for optional types and an empty sequence for repeated types.

isSet :: msg -> a -> Bool

Check whether data is present in the message.

• Required fields always return True.
• Optional fields return whether a value is present.
• Repeated field return False if there are no values, otherwise they return True.
• Keys return as optional or repeated, but checks only if the field # is present. This assumes that there are no collisions where more that one key refers to the same field number of this message type.

Instances

MessageAPI msg (msg -> Word64) Word64

MessageAPI msg (msg -> Word32) Word32

MessageAPI msg (msg -> Int64) Int64

MessageAPI msg (msg -> Int32) Int32

MessageAPI msg (msg -> Float) Float

MessageAPI msg (msg -> Double) Double

MessageAPI msg (msg -> Utf8) Utf8

MessageAPI msg (msg -> ByteString) ByteString

(Default msg, Default a) => MessageAPI msg (msg -> Maybe a) a

MessageAPI msg (msg -> Seq a) (Seq a)

Default v => MessageAPI msg (Key Maybe msg v) v

Default v => MessageAPI msg (Key Seq msg v) (Seq v)

newtype PackedSeq a

The PackedSeq is needed to distinguish the packed repeated format from the repeated format. This is only used in the phantom type of Key.

Constructors

PackedSeq

Fields

unPackedSeq :: Seq a

Instances

Typeable1 PackedSeq

ExtKey PackedSeq

data EP

Constructors

EP !WireType !ByteString

Instances

Eq EP

Data EP

Ord EP

Show EP

Typeable EP

Internal types, functions, and classes

wireSizeExtField :: ExtField -> WireSize

This is used by the generated code

wirePutExtField :: ExtField -> Put

This is used by the generated code. The data is serialized in order of increasing field number.

loadExtension :: (ReflectDescriptor a, ExtendMessage a) => FieldId -> WireType -> a -> Get a

get a value from the wire into the message's ExtField. This is used by generated code for extensions that were not known at compile time.

notExtension :: (ReflectDescriptor a, ExtendMessage a, Typeable a) => FieldId -> WireType -> a -> Get a

wireGetKeyToUnPacked :: (ExtendMessage msg, GPB v) => Key Seq msg v -> msg -> Get msg

wireGetKeyToPacked :: (ExtendMessage msg, GPB v) => Key PackedSeq msg v -> msg -> Get msg

class (Mergeable a, Default a, Wire a, Show a, Typeable a, Eq a, Ord a) => GPB a

The Key and GPWitness GADTs use GPB as a shorthand for many classes.

Instances

GPB Bool

GPB Double

GPB Float

GPB Int32

GPB Int64

GPB Word32

GPB Word64

GPB ByteString

GPB Utf8

newtype ExtField

ExtField is a newtype'd map from the numeric FieldId key to the ExtFieldValue. This allows for the needed class instances.

Constructors

ExtField (Map FieldId ExtFieldValue)

Instances

Eq ExtField

Data ExtField

Ord ExtField

Show ExtField

Typeable ExtField

Default ExtField

Mergeable ExtField

class Typeable msg => ExtendMessage msg where

ExtendMessage abstracts the operations of storing and retrieving the ExtField from the message, and provides the reflection needed to know the valid field numbers.

This only used internally.

Methods

getExtField :: msg -> ExtField

putExtField :: ExtField -> msg -> msg

validExtRanges :: msg -> [(FieldId, FieldId)]

data ExtFieldValue

The WireType is used to ensure the Seq is homogenous. The ByteString is the unparsed input after the tag.

Constructors

ExtFromWire !(Seq EP)

ExtOptional !FieldType !GPDyn

ExtRepeated !FieldType !GPDynSeq

ExtPacked !FieldType !GPDynSeq

Instances

Eq ExtFieldValue

Ord ExtFieldValue

Show ExtFieldValue

Typeable ExtFieldValue