Data.ProtoLens.Encoding.Wire

Module defining the individual base wire types (e.g. VarInt, Fixed64).

They are used to represent the unknownFields within the proto message.

Upstream docs: https://developers.google.com/protocol-buffers/docs/encoding#structure

Documentation

newtype Tag

A tag that identifies a particular field of the message when converting to/from the wire format.

Constructors

Tag

Fields

• unTag :: Int

Instances

Num Tag

Defined in Data.ProtoLens.Encoding.Wire

Methods

(+) :: Tag -> Tag -> Tag

(-) :: Tag -> Tag -> Tag

(*) :: Tag -> Tag -> Tag

negate :: Tag -> Tag

abs :: Tag -> Tag

signum :: Tag -> Tag

fromInteger :: Integer -> Tag

Show Tag

Defined in Data.ProtoLens.Encoding.Wire

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

NFData Tag

Defined in Data.ProtoLens.Encoding.Wire

Methods

rnf :: Tag -> ()

Eq Tag

Defined in Data.ProtoLens.Encoding.Wire

Methods

(==) :: Tag -> Tag -> Bool

(/=) :: Tag -> Tag -> Bool

Ord Tag

Defined in Data.ProtoLens.Encoding.Wire

Methods

compare :: Tag -> Tag -> Ordering

(<) :: Tag -> Tag -> Bool

(<=) :: Tag -> Tag -> Bool

(>) :: Tag -> Tag -> Bool

(>=) :: Tag -> Tag -> Bool

max :: Tag -> Tag -> Tag

min :: Tag -> Tag -> Tag

data TaggedValue

A pair of an encoded field and a value.

Constructors

TaggedValue !Tag !WireValue

Instances

NFData TaggedValue

Defined in Data.ProtoLens.Encoding.Wire

Methods

rnf :: TaggedValue -> ()

Eq TaggedValue

Defined in Data.ProtoLens.Encoding.Wire

Methods

(==) :: TaggedValue -> TaggedValue -> Bool

(/=) :: TaggedValue -> TaggedValue -> Bool

Ord TaggedValue

Defined in Data.ProtoLens.Encoding.Wire

Methods

compare :: TaggedValue -> TaggedValue -> Ordering

(<) :: TaggedValue -> TaggedValue -> Bool

(<=) :: TaggedValue -> TaggedValue -> Bool

(>) :: TaggedValue -> TaggedValue -> Bool

(>=) :: TaggedValue -> TaggedValue -> Bool

max :: TaggedValue -> TaggedValue -> TaggedValue

min :: TaggedValue -> TaggedValue -> TaggedValue

data WireValue

The encoding of some unknown field on the wire.

Constructors

VarInt !Word64

Fixed64 !Word64

Lengthy !ByteString

StartGroup

EndGroup

Fixed32 !Word32

Instances

NFData WireValue

Defined in Data.ProtoLens.Encoding.Wire

Methods

rnf :: WireValue -> ()

Eq WireValue

Defined in Data.ProtoLens.Encoding.Wire

Methods

(==) :: WireValue -> WireValue -> Bool

(/=) :: WireValue -> WireValue -> Bool

Ord WireValue

Defined in Data.ProtoLens.Encoding.Wire

Methods

compare :: WireValue -> WireValue -> Ordering

(<) :: WireValue -> WireValue -> Bool

(<=) :: WireValue -> WireValue -> Bool

(>) :: WireValue -> WireValue -> Bool

(>=) :: WireValue -> WireValue -> Bool

max :: WireValue -> WireValue -> WireValue

min :: WireValue -> WireValue -> WireValue

type FieldSet = [TaggedValue]

splitTypeAndTag :: Word64 -> (Tag, Word8)

joinTypeAndTag :: Tag -> Word8 -> Word64

parseFieldSet :: Parser FieldSet

buildFieldSet :: FieldSet -> Builder

buildMessageSet :: FieldSet -> Builder

parseTaggedValueFromWire :: Word64 -> Parser TaggedValue

parseMessageSetTaggedValueFromWire :: Word64 -> Parser TaggedValue