proto3-wire-1.4.6: A low-level implementation of the Protocol Buffers (version 3) wire format
Safe HaskellNone
LanguageHaskell2010

Proto3.Wire.Types

Description

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

Synopsis

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

Instances

Instances details
Arbitrary FieldNumber Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

arbitrary :: Gen FieldNumber #

shrink :: FieldNumber -> [FieldNumber] #

Data FieldNumber Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FieldNumber -> c FieldNumber #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FieldNumber #

toConstr :: FieldNumber -> Constr #

dataTypeOf :: FieldNumber -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FieldNumber) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FieldNumber) #

gmapT :: (forall b. Data b => b -> b) -> FieldNumber -> FieldNumber #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FieldNumber -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FieldNumber -> r #

gmapQ :: (forall d. Data d => d -> u) -> FieldNumber -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> FieldNumber -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FieldNumber -> m FieldNumber #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FieldNumber -> m FieldNumber #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FieldNumber -> m FieldNumber #

Bounded FieldNumber Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

minBound :: FieldNumber #

maxBound :: FieldNumber #

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] #

Generic FieldNumber Source # 
Instance details

Defined in Proto3.Wire.Types

Associated Types

type Rep FieldNumber 
Instance details

Defined in Proto3.Wire.Types

type Rep FieldNumber = D1 ('MetaData "FieldNumber" "Proto3.Wire.Types" "proto3-wire-1.4.6-CRlwbrcQnvz56vF5AH6Bds" 'True) (C1 ('MetaCons "FieldNumber" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFieldNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from :: FieldNumber -> Rep FieldNumber x #

to :: Rep FieldNumber x -> FieldNumber #

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 #

Show FieldNumber Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

showsPrec :: Int -> FieldNumber -> ShowS #

show :: FieldNumber -> String #

showList :: [FieldNumber] -> ShowS #

NFData FieldNumber Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

rnf :: FieldNumber -> () #

Eq FieldNumber Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

(==) :: FieldNumber -> FieldNumber -> Bool #

(/=) :: FieldNumber -> FieldNumber -> Bool #

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 #

Hashable FieldNumber Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

hashWithSalt :: Int -> FieldNumber -> Int #

hash :: FieldNumber -> Int #

Lift FieldNumber Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

lift :: Quote m => FieldNumber -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => FieldNumber -> Code m FieldNumber #

type Rep FieldNumber Source # 
Instance details

Defined in Proto3.Wire.Types

type Rep FieldNumber = D1 ('MetaData "FieldNumber" "Proto3.Wire.Types" "proto3-wire-1.4.6-CRlwbrcQnvz56vF5AH6Bds" 'True) (C1 ('MetaCons "FieldNumber" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFieldNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

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

Instances details
Data WireType Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WireType -> c WireType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WireType #

toConstr :: WireType -> Constr #

dataTypeOf :: WireType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c WireType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WireType) #

gmapT :: (forall b. Data b => b -> b) -> WireType -> WireType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WireType -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WireType -> r #

gmapQ :: (forall d. Data d => d -> u) -> WireType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WireType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WireType -> m WireType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WireType -> m WireType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WireType -> m WireType #

Bounded WireType Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

minBound :: WireType #

maxBound :: WireType #

Enum WireType Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

succ :: WireType -> WireType #

pred :: WireType -> WireType #

toEnum :: Int -> WireType #

fromEnum :: WireType -> Int #

enumFrom :: WireType -> [WireType] #

enumFromThen :: WireType -> WireType -> [WireType] #

enumFromTo :: WireType -> WireType -> [WireType] #

enumFromThenTo :: WireType -> WireType -> WireType -> [WireType] #

Generic WireType Source # 
Instance details

Defined in Proto3.Wire.Types

Associated Types

type Rep WireType 
Instance details

Defined in Proto3.Wire.Types

type Rep WireType = D1 ('MetaData "WireType" "Proto3.Wire.Types" "proto3-wire-1.4.6-CRlwbrcQnvz56vF5AH6Bds" 'False) ((C1 ('MetaCons "Varint" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Fixed32" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Fixed64" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LengthDelimited" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: WireType -> Rep WireType x #

to :: Rep WireType x -> WireType #

Show WireType Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

showsPrec :: Int -> WireType -> ShowS #

show :: WireType -> String #

showList :: [WireType] -> ShowS #

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 #

Lift WireType Source # 
Instance details

Defined in Proto3.Wire.Types

Methods

lift :: Quote m => WireType -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => WireType -> Code m WireType #

type Rep WireType Source # 
Instance details

Defined in Proto3.Wire.Types

type Rep WireType = D1 ('MetaData "WireType" "Proto3.Wire.Types" "proto3-wire-1.4.6-CRlwbrcQnvz56vF5AH6Bds" 'False) ((C1 ('MetaCons "Varint" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Fixed32" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Fixed64" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LengthDelimited" 'PrefixI 'False) (U1 :: Type -> Type)))