Annotates MessageBuilder with the type of protobuf message it encodes. Prefix a tag and length to turn the message into a submessage of a larger message.

Serialize a message (or portion thereof) as a lazy ByteString.

Serialize a message (or portion thereof) as a strict ByteString.

Functionally equivalent to toStrict . messageEncoderToLazyByteString, and currently even the performance is the same.

Like etaMessageBuilder but for MessageEncoder.

The unsafe but fast inverse of messageEncoderToByteString.

The octet sequence that would be emitted by some MessageEncoder having the same type parameter.

(This type is not a Semigroup because combining encodings that both have the same non-repeated field is arguably incorrect, even though the standard asks parsers to to try to work around such improper repetition.)

See also: cacheMessageEncoding

Creates a message encoding by means of type class Message.

Equivalent to cacheMessageEncoding . messageReflection.

Precomputes the octet sequence that would be written by the given MessageEncoder. Do this only if you expect to reuse that specific octet sequence repeatedly.

cachedMessageEncoding . cacheMessageEncoding is functionally equivalent to id but has different performance characteristics.

See also: cacheFieldsEncoding.

Encodes a precomputed MessageEncoder by copying octets from a memory buffer. See cacheMessageEncoding.

See also: cachedFieldsEncoding

Strips type information from the message encoding, leaving only its octets.

Unsafe because the caller must ensure that the given octets are in the correct format for a message of the specified type.

A Category on builders that prefix zero or more fields to a message. Use . to accumulate prefixes to create an MessageEncoder for a whole message.

The first type parameter specifies the type of message being built.

The second and third type parameters list the names of some subset of the oneofs and non-repeatable non-oneof fields possible within the type of message specified by the first type parameter. The third type parameter must be a suffix of the second, and limits the oneofs and non-repeatable non-oneof fields that may occur in any builder which follows the contained builder. The first parameter prefixes the names of the oneofs and non-repeatable non-oneof fields that might be written by the contained builder.

If a name ends up listed more than once, that will eventually be detected as a compilation error; see type family Distinct.

Note that this type system permits multiple blocks of the same packed repeated field. Though that would be less compact than a single block, it is allowed by the protobuf standard.

See also: cacheFieldsEncoder

Like etaMessageBuilder but for FieldsEncoder.

The octet sequence that would be prefixed by some FieldsEncoder having the same type parameters.

Precomputes the octet sequence that would be written by the given FieldsEncoder. Do this only if you expect to reuse that specific octet sequence repeatedly.

cachedFieldsEncoding . cacheFieldsEncoding is functionally equivalent to id but has different performance characteristics.

See also: cacheMessageEncoding

Encodes a precomputed FieldsEncoder by copying octets from a memory buffer. See cacheFieldsEncoding.

See also: cachedMessageEncoding.

Yields a satisfied constraint if the given list of names contains no duplicates after first filtering out the names of repeated fields and replacing the names of oneof fields with their oneof names. Otherwise raises a compilation error mentioning the repeated names.

Reports nonempty output of RepeatedNames as applied to the result of OccupiedOnly.

This type family is an implementation detail of Distinct that is subject to change, and is exported only to assist in understanding of compilation errors.

Given a list of names, returns the non-repeating list of names that occur more than once in the given list.

This type family is an implementation detail of Distinct that is subject to change, and is exported only to assist in understanding of compilation errors.

Helps to implement RepeatedNames.

This type family is an implementation detail of Distinct that is subject to change, and is exported only to assist in understanding of compilation errors.

Is the given name absent from the given list of names?

This type family is an implementation detail of RepeatedNames that is subject to change, and is exported only to assist in understanding of compilation errors.

Strips all occurrences of the given name, leaving behind all other name occurrences.

This type family is an implementation detail of RepeatedNames that is subject to change, and is exported only to assist in understanding of compilation errors.

Filters out the repeated field names and replaces oneof fields with their oneof names.

We do this in case omitted is used to introduce the names of repeated fields or fields that are contained within oneofs; see the explanatory comments there.

This type family is an implementation detail of Distinct that is subject to change, and is exported only to assist in understanding of compilation errors.

Helps to implement OccupiedOnly.

This type family is an implementation detail of Distinct that is subject to change, and is exported only to assist in understanding of compilation errors.

Relabels a prefix of fields of a message as an encoding for the message as a whole (though without any tag or length that would make it a submessage).

Among the names of the given message, prefixes the given name with the following exceptions:

• Names of repeatable fields are not prefixed; there is no need to avoid their repetition.
• When a field of a oneof is named, the name of the entire oneof is prefixed in order to prevent further emission of any of its fields.

Helps to implement Occupy.

This type family is an implementation detail of Occupy that is subject to change, and is exported only to assist in understanding of compilation errors.

The constraint that moreNames is names, but possibly with additional names inserted. For simplicity, reordering is not currently allowed.

Uses an empty encoding for the oneofs and non-oneof message fields that appear in the final type parameter of FieldsEncoder but not the previous type parameter, thereby implicitly emitting their default values.

This function is not always required, but becomes necessary when there are two code paths, one of which may write non-repeatable fields and one of which leaves some implicitly defaulted. This function reconciles the types of the two code paths.

This function should not be used to introduce the name of a field that is repeated or belongs to oneof, because doing so could confuse the reader. But such misuse is unlikely to be accidental, and the Distinct constraint compensates by ignoring repeated fields and replacing oneof fields with their oneof names.

Provides the term-level value of the given field number type.

Provides the (term-level) field number of the field having the specified message type and field name.

Provides a way to encode a field with the given name from a given type. That name is interpreted in the context of a given type of message.

More than one argument type may be supported for any given field; see further discussion in the comments for FieldForm, to which this type class delegates after determining the cardinality and protobuf type of the field in question.

Implements Field for all fields having the specified cardinality, protobuf type, and type of argument to be encoded within that field.

Argument Type:

For any given cardinality and protobuf type there may be multiple instances of this class for different types of argument. For example, a field of protobuf type sint64 may be encoded from any of the Haskell types Int8, Word8, Int16, Word16, Int32, Word32, or Int64. Note that this library does not provide an instance for Word64 because its values greater than or equal to 2 ^ 63 cannot be represented by sint64.

As another example, for fields of submessage type m there are type class instances for both MessageEncoder m and MessageEncoding m (wrapped in a suitable container if repeated or outside of a oneof).

Arguments for optional fields are often expressed using Maybe, and arguments for repeated fields are often expressed in using Forward, Reverse, and Reverse--the choice is up to the user.

Of course, if you add instances of this type class then please be sure to consider how they might overlap with existing instances, and try to avoid overly broad instances that might cause ambiguity.

However, this library does provide some general instances:

• An instance for Optional with Maybe that delegates to the corresponding instance for Optional with Identity.
• An instance for Repeated Unpacked that delegates to the corresponding instance for Optional with Identity.
• An instance for Repeated Packed that delegates to PackedFieldForm.

Design Note:

Importantly, the type parameters of this type class do not mention the containing message type, field name, or field number, thus allowing it to be broadly applicable to all containing message types.

Furthermore, type class Field has a general-purpose definition that need not be specialized for particular message types: one that makes use of KnownFieldNumber, ProtoTypeOf, and this type class (though in order to simplify usage, Field is a full type class, not a mere constraint alias with a related function).

In this way the only message-specific instances are of type classes defined in Proto3.Suite.Form, which declare message format without specifying any policy regarding how to efficiently encode or which Haskell types may be encoded.