Safe Haskell	None
Language	Haskell2010

Proto3.Wire.Types

Contents

Message Structure

Description

This module defines types which are shared by the encoding and decoding modules.

Synopsis

newtype FieldNumber = FieldNumber {
- getFieldNumber :: Word64
}
fieldNumber :: Word64 -> FieldNumber
data WireType
- = Varint
- | Fixed32
- | Fixed64
- | LengthDelimited

Message Structure

newtype FieldNumber Source #

A FieldNumber identifies a field inside a protobufs message.

This library makes no attempt to generate these automatically, or even make sure that field numbers are provided in increasing order. Such things are left to other, higher-level libraries.

Constructors

FieldNumber
Fields getFieldNumber :: Word64

Instances

Enum FieldNumber Source #
Instance details Defined in Proto3.Wire.Types Methods succ :: FieldNumber -> FieldNumber # pred :: FieldNumber -> FieldNumber # toEnum :: Int -> FieldNumber # fromEnum :: FieldNumber -> Int # enumFrom :: FieldNumber -> [FieldNumber] # enumFromThen :: FieldNumber -> FieldNumber -> [FieldNumber] # enumFromTo :: FieldNumber -> FieldNumber -> [FieldNumber] # enumFromThenTo :: FieldNumber -> FieldNumber -> FieldNumber -> [FieldNumber] #
Eq FieldNumber Source #
Instance details Defined in Proto3.Wire.Types Methods (==) :: FieldNumber -> FieldNumber -> Bool # (/=) :: FieldNumber -> FieldNumber -> Bool #
Num FieldNumber Source #
Instance details Defined in Proto3.Wire.Types Methods (+) :: FieldNumber -> FieldNumber -> FieldNumber # (-) :: FieldNumber -> FieldNumber -> FieldNumber # (*) :: FieldNumber -> FieldNumber -> FieldNumber # negate :: FieldNumber -> FieldNumber # abs :: FieldNumber -> FieldNumber # signum :: FieldNumber -> FieldNumber # fromInteger :: Integer -> FieldNumber #
Ord FieldNumber Source #
Instance details Defined in Proto3.Wire.Types Methods compare :: FieldNumber -> FieldNumber -> Ordering # (<) :: FieldNumber -> FieldNumber -> Bool # (<=) :: FieldNumber -> FieldNumber -> Bool # (>) :: FieldNumber -> FieldNumber -> Bool # (>=) :: FieldNumber -> FieldNumber -> Bool # max :: FieldNumber -> FieldNumber -> FieldNumber # min :: FieldNumber -> FieldNumber -> FieldNumber #
Show FieldNumber Source #
Instance details Defined in Proto3.Wire.Types Methods showsPrec :: Int -> FieldNumber -> ShowS # show :: FieldNumber -> String # showList :: [FieldNumber] -> ShowS #
Arbitrary FieldNumber Source #
Instance details Defined in Proto3.Wire.Types Methods arbitrary :: Gen FieldNumber # shrink :: FieldNumber -> [FieldNumber] #
NFData FieldNumber Source #
Instance details Defined in Proto3.Wire.Types Methods rnf :: FieldNumber -> () #
Hashable FieldNumber Source #
Instance details Defined in Proto3.Wire.Types Methods hashWithSalt :: Int -> FieldNumber -> Int # hash :: FieldNumber -> Int #

fieldNumber :: Word64 -> FieldNumber Source #

Create a FieldNumber given the (one-based) integer which would label the field in the corresponding .proto file.

data WireType Source #

The (non-deprecated) wire types identified by the Protocol Buffers specification.

Constructors

Varint
Fixed32
Fixed64
LengthDelimited

Instances

Eq WireType Source #
Instance details Defined in Proto3.Wire.Types Methods (==) :: WireType -> WireType -> Bool # (/=) :: WireType -> WireType -> Bool #
Ord WireType Source #
Instance details Defined in Proto3.Wire.Types Methods compare :: WireType -> WireType -> Ordering # (<) :: WireType -> WireType -> Bool # (<=) :: WireType -> WireType -> Bool # (>) :: WireType -> WireType -> Bool # (>=) :: WireType -> WireType -> Bool # max :: WireType -> WireType -> WireType # min :: WireType -> WireType -> WireType #
Show WireType Source #
Instance details Defined in Proto3.Wire.Types Methods showsPrec :: Int -> WireType -> ShowS # show :: WireType -> String # showList :: [WireType] -> ShowS #