Data.ProtoBufInt

Internal functions used by the generated types.

Documentation

class Default a where

Typeclass to handle default values.

Methods

defaultVal :: a

The default value for the field.

Instances

Default Bool

Default Double

Default Float

Default Int32

Default Int64

Default Word32

Default Word64

Default ByteString

Default Text

Default (Maybe a)

Default (Seq a)

newtype FieldNumber

Type to represent a field number (unique numbered tag).

Constructors

FieldNumber Word32

Instances

Eq FieldNumber

Num FieldNumber

Ord FieldNumber

Show FieldNumber

fromFieldNumber :: FieldNumber -> Word32

Convert a FieldNumber into a Word32.

toFieldNumber :: Word32 -> Either String FieldNumber

Convert a Word32 into a FieldNumber or an error.

class Mergeable a where

Typeclass to handle merging of values.

Minimal complete definition

Nothing

Methods

merge :: a -> a -> a

Merge two values.

Instances

Mergeable Bool

Mergeable Double

Mergeable Float

Mergeable Int32

Mergeable Int64

Mergeable Word32

Mergeable Word64

Mergeable ByteString

Mergeable Text

Mergeable a => Mergeable (Maybe a)

Mergeable (Seq a)

class Required a where

Typeclass to retrieve required WireTags.

Methods

reqTags :: a -> Set WireTag

The required WireTags for the data type.

class WireEnum a where

Typeclass to handle encoding en decoding of enums.

Methods

intToEnum :: Int32 -> a

Convert an Int32 to an enum value.

enumToInt :: a -> Int32

Convert a enum value to an Int32.

class Default a where

Typeclass to handle default values.

Methods

defaultVal :: a

The default value for the field.

Instances

Default Bool

Default Double

Default Float

Default Int32

Default Int64

Default Word32

Default Word64

Default ByteString

Default Text

Default (Maybe a)

Default (Seq a)

newtype FieldNumber

Type to represent a field number (unique numbered tag).

Constructors

FieldNumber Word32

Instances

Eq FieldNumber

Num FieldNumber

Ord FieldNumber

Show FieldNumber

fromFieldNumber :: FieldNumber -> Word32

Convert a FieldNumber into a Word32.

toFieldNumber :: Word32 -> Either String FieldNumber

Convert a Word32 into a FieldNumber or an error.

class Mergeable a where

Typeclass to handle merging of values.

Minimal complete definition

Nothing

Methods

merge :: a -> a -> a

Merge two values.

Instances

Mergeable Bool

Mergeable Double

Mergeable Float

Mergeable Int32

Mergeable Int64

Mergeable Word32

Mergeable Word64

Mergeable ByteString

Mergeable Text

Mergeable a => Mergeable (Maybe a)

Mergeable (Seq a)

class Required a where

Typeclass to retrieve required WireTags.

Methods

reqTags :: a -> Set WireTag

The required WireTags for the data type.

class WireEnum a where

Typeclass to handle encoding en decoding of enums.

Methods

intToEnum :: Int32 -> a

Convert an Int32 to an enum value.

enumToInt :: a -> Int32

Convert a enum value to an Int32.

class WireMessage a where

Typeclass to handle encoding and decoding of messages.

Methods

fieldToValue :: WireTag -> a -> Get a

Decode a field and merge it with the existing value in the message.

messageToFields :: a -> Put

Encode all the fields of the message.

data WireTag

Type to represent a wire tag.

Constructors

WireTag FieldNumber WireType

Instances

Eq WireTag

Ord WireTag

Show WireTag

fromWireTag :: WireTag -> Word32

Convert a WireTag into a Word32.

toWireTag :: Word32 -> Either String WireTag

Convert a Word32 into a WireTag or an error.

data WireType

Type to represent the Protocol Buffers wire type.

Constructors

VarInt

The varint type: int32, int64, uint32, sint32, sint64, bool enum

Bit64

The 64-bit type: fixed64, sfixed64, double

LenDelim

The length-delimited: string, bytes, embedded messages, packed repeated fields

Bit32

The 32-bit type: fixed32, sfixed32, float

Instances

Eq WireType

Ord WireType

Show WireType

fromWireType :: WireType -> Word32

Convert a WireType into a Word32.

toWireType :: Word32 -> Either String WireType

Convert a Word32 into a WireType or an error.

decode :: (Default a, Required a, WireMessage a) => ByteString -> Either String a

Decode a ByteString into either the data-type or an error message.

Decode CustomType:

decCustomType :: ByteString -> Either String CustomType
decCustomType = decode

encode :: WireMessage a => a -> ByteString

Encode a data-type into a ByteString.

Encode CustomType:

encCustomType :: CustomType -> ByteString
encCustomType = encode

getBool :: Get Bool

Decode a required bool field.

getBoolOpt :: Get (Maybe Bool)

Decode an optional bool field.

getBoolPacked :: Get (Seq Bool)

Decode a packed repeated bool field.

getBytes :: Get ByteString

Decode a required bytes field.

getBytesOpt :: Get (Maybe ByteString)

Decode an optional bytes field.

getDouble :: Get Double

Decode a required double field.

getDoubleOpt :: Get (Maybe Double)

Decode an optional double field.

getDoublePacked :: Get (Seq Double)

Decode a packed repeated double field.

getEnum :: WireEnum a => Get a

Decode a required enum field.

getEnumOpt :: WireEnum a => Get (Maybe a)

Decode an optional enum field.

getEnumPacked :: WireEnum a => Get (Seq a)

Decode a packed repeated enum field.

getFixed32 :: Get Word32

Decode a required fixed32 field.

getFixed32Opt :: Get (Maybe Word32)

Decode an optional fixed32 field.

getFixed32Packed :: Get (Seq Word32)

Decode a packed repeated fixed32 field.

getFixed64 :: Get Word64

Decode a required fixed64 field.

getFixed64Opt :: Get (Maybe Word64)

Decode an optional fixed64 field.

getFixed64Packed :: Get (Seq Word64)

Decode a packed repeated fixed64 field.

getFloat :: Get Float

Decode a required float field.

getFloatOpt :: Get (Maybe Float)

Decode an optional float field.

getFloatPacked :: Get (Seq Float)

Decode a packed repeated float field.

getGroup :: (Default a, Required a, WireMessage a) => Get a

Decode a required group field.

getGroupOpt :: (Default a, Required a, WireMessage a) => Get (Maybe a)

Decode an optional group field.

getInt32 :: Get Int32

Decode a required int32 field.

getInt32Opt :: Get (Maybe Int32)

Decode an optional int32 field.

getInt32Packed :: Get (Seq Int32)

Decode a packed repeated int32 field.

getInt64 :: Get Int64

Decode a required int64 field.

getInt64Opt :: Get (Maybe Int64)

Decode an optional int64 field.

getInt64Packed :: Get (Seq Int64)

Decode a packed repeated int64 field.

getMessage :: (Default a, Required a, WireMessage a) => Get a

Decode a required message field.

getMessageOpt :: (Default a, Required a, WireMessage a) => Get (Maybe a)

Decode an optional message field.

getSFixed32 :: Get Int32

Decode a required sfixed32 field.

getSFixed32Opt :: Get (Maybe Int32)

Decode an optional sfixed32 field.

getSFixed32Packed :: Get (Seq Int32)

Decode a packed repeated sfixed32 field.

getSFixed64 :: Get Int64

Decode a required sfixed64 field.

getSFixed64Opt :: Get (Maybe Int64)

Decode an optional sfixed64 field.

getSFixed64Packed :: Get (Seq Int64)

Decode a packed repeated sfixed64 field.

getSInt32 :: Get Int32

Decode a required sint32 field.

getSInt32Opt :: Get (Maybe Int32)

Decode an optional sint32 field.

getSInt32Packed :: Get (Seq Int32)

Decode a packed repeated sint32 field.

getSInt64 :: Get Int64

Decode a required sint64 field.

getSInt64Opt :: Get (Maybe Int64)

Decode an optional sint64 field.

getSInt64Packed :: Get (Seq Int64)

Decode a packed repeated sint64 field.

getString :: Get Text

Decode a required string.

getStringOpt :: Get (Maybe Text)

Decode an optional string.

getUInt32 :: Get Word32

Decode a required uint32 field.

getUInt32Opt :: Get (Maybe Word32)

Decode an optional uint32 field.

getUInt32Packed :: Get (Seq Word32)

Decode a packed repeated uint32 field.

getUInt64 :: Get Word64

Decode a required uint64 field.

getUInt64Opt :: Get (Maybe Word64)

Decode an optional uint64 field.

getUInt64Packed :: Get (Seq Word64)

Decode a packed repeated uint64 field.

getUnknown :: WireTag -> a -> Get a

Skip an unknown field.

getWireTag :: Get WireTag

Decode a wire tag.

putBool :: WireTag -> Bool -> Put

Encode a required bool field.

putBoolList :: WireTag -> Seq Bool -> Put

Encode a repeated bool field.

putBoolOpt :: WireTag -> Maybe Bool -> Put

Encode an optional bool field.

putBoolPacked :: WireTag -> Seq Bool -> Put

Encode a packed repeated bool field.

putBytes :: WireTag -> ByteString -> Put

Encode a required bytes field.

putBytesList :: WireTag -> Seq ByteString -> Put

Encode a repeated bytes field.

putBytesOpt :: WireTag -> Maybe ByteString -> Put

Encode an optional bytes field.

putDouble :: WireTag -> Double -> Put

Encode a required double field.

putDoubleList :: WireTag -> Seq Double -> Put

Encode a repeated double field.

putDoubleOpt :: WireTag -> Maybe Double -> Put

Encode an optional double field.

putDoublePacked :: WireTag -> Seq Double -> Put

Encode a packed repeated double field.

putEnum :: WireEnum a => WireTag -> a -> Put

Encode a required enum field.

putEnumList :: WireEnum a => WireTag -> Seq a -> Put

Encode a repeated enum field.

putEnumOpt :: WireEnum a => WireTag -> Maybe a -> Put

Encode an optional enum field.

putEnumPacked :: WireEnum a => WireTag -> Seq a -> Put

Encode a packed repeated enum field.

putFixed32 :: WireTag -> Word32 -> Put

Encode a required fixed32 field.

putFixed32List :: WireTag -> Seq Word32 -> Put

Encode a repeated fixed32 field.

putFixed32Opt :: WireTag -> Maybe Word32 -> Put

Encode an optional fixed32 field.

putFixed32Packed :: WireTag -> Seq Word32 -> Put

Encode a packed repeated fixed32 field.

putFixed64 :: WireTag -> Word64 -> Put

Encode a required fixed64 field.

putFixed64List :: WireTag -> Seq Word64 -> Put

Encode a repeated fixed64 field.

putFixed64Opt :: WireTag -> Maybe Word64 -> Put

Encode an optional fixed64 field.

putFixed64Packed :: WireTag -> Seq Word64 -> Put

Encode a packed repeated fixed64 field.

putFloat :: WireTag -> Float -> Put

Encode a required float field.

putFloatList :: WireTag -> Seq Float -> Put

Encode a repeated float field.

putFloatOpt :: WireTag -> Maybe Float -> Put

Encode an optional float field.

putFloatPacked :: WireTag -> Seq Float -> Put

Encode a packed repeated float field.

putGroup :: WireMessage a => a -> Put

Encode a required group field.

putGroupOpt :: WireMessage a => Maybe a -> Put

Encode an optional group field.

putInt32 :: WireTag -> Int32 -> Put

Encode a required int32 field.

putInt32List :: WireTag -> Seq Int32 -> Put

Encode a repeated int32 field.

putInt32Opt :: WireTag -> Maybe Int32 -> Put

Encode an optional int32 field.

putInt32Packed :: WireTag -> Seq Int32 -> Put

Encode a packed repeated int32 field.

putInt64 :: WireTag -> Int64 -> Put

Encode a required int64 field.

putInt64List :: WireTag -> Seq Int64 -> Put

Encode a repeated int64 field.

putInt64Opt :: WireTag -> Maybe Int64 -> Put

Encode an optional int64 field.

putInt64Packed :: WireTag -> Seq Int64 -> Put

Encode a packed repeated int64 field.

putSFixed32 :: WireTag -> Int32 -> Put

Encode a required sfixed32 field.

putSFixed32List :: WireTag -> Seq Int32 -> Put

Encode a repeated sfixed32 field.

putSFixed32Opt :: WireTag -> Maybe Int32 -> Put

Encode an optional sfixed32 field.

putSFixed32Packed :: WireTag -> Seq Int32 -> Put

Encode a packed repeated sfixed32 field.

putSFixed64 :: WireTag -> Int64 -> Put

Encode a required sfixed64 field.

putSFixed64List :: WireTag -> Seq Int64 -> Put

Encode a repeated sfixed64 field.

putSFixed64Opt :: WireTag -> Maybe Int64 -> Put

Encode an optional sfixed64 field.

putSFixed64Packed :: WireTag -> Seq Int64 -> Put

Encode a packed repeated sfixed64 field.

putSInt32 :: WireTag -> Int32 -> Put

Encode a required sint32 field.

putSInt32List :: WireTag -> Seq Int32 -> Put

Encode a repeated sint32 field.

putSInt32Opt :: WireTag -> Maybe Int32 -> Put

Encode an optional sint32 field.

putSInt32Packed :: WireTag -> Seq Int32 -> Put

Encode a packed repeated sint32 field.

putSInt64 :: WireTag -> Int64 -> Put

Encode a required sint64 field.

putSInt64List :: WireTag -> Seq Int64 -> Put

Encode a repeated sint64 field.

putSInt64Opt :: WireTag -> Maybe Int64 -> Put

Encode an optional sint64 field.

putSInt64Packed :: WireTag -> Seq Int64 -> Put

Encode a packed repeated sint64 field.

putMessage :: WireMessage a => WireTag -> a -> Put

Encode a required message field.

putMessageList :: WireMessage a => WireTag -> Seq a -> Put

Encode a repeated message field.

putMessageOpt :: WireMessage a => WireTag -> Maybe a -> Put

Encode an optional message field.

putString :: WireTag -> Text -> Put

Encode a required string field.

putStringList :: WireTag -> Seq Text -> Put

Encode a repeated string field.

putStringOpt :: WireTag -> Maybe Text -> Put

Encode an optional string field.

putUInt32 :: WireTag -> Word32 -> Put

Encode a required uint32 field.

putUInt32List :: WireTag -> Seq Word32 -> Put

Encode a repeated uint32 field.

putUInt32Opt :: WireTag -> Maybe Word32 -> Put

Encode an optional uint32 field.

putUInt32Packed :: WireTag -> Seq Word32 -> Put

Encode a packed repeated uint32 field.

putUInt64 :: WireTag -> Word64 -> Put

Encode a required uint64 field.

putUInt64List :: WireTag -> Seq Word64 -> Put

Encode a repeated uint64 field.

putUInt64Opt :: WireTag -> Maybe Word64 -> Put

Encode an optional uint64 field.

putUInt64Packed :: WireTag -> Seq Word64 -> Put

Encode a packed repeated uint64 field.

putWireTag :: WireTag -> Put

Encode a wire tag.

class WireMessage a where

Typeclass to handle encoding and decoding of messages.

Methods

fieldToValue :: WireTag -> a -> Get a

Decode a field and merge it with the existing value in the message.

messageToFields :: a -> Put

Encode all the fields of the message.

data WireTag

Type to represent a wire tag.

Constructors

WireTag FieldNumber WireType

Instances

Eq WireTag

Ord WireTag

Show WireTag

fromWireTag :: WireTag -> Word32

Convert a WireTag into a Word32.

toWireTag :: Word32 -> Either String WireTag

Convert a Word32 into a WireTag or an error.

data WireType

Type to represent the Protocol Buffers wire type.

Constructors

VarInt

The varint type: int32, int64, uint32, sint32, sint64, bool enum

Bit64

The 64-bit type: fixed64, sfixed64, double

LenDelim

The length-delimited: string, bytes, embedded messages, packed repeated fields

Bit32

The 32-bit type: fixed32, sfixed32, float

Instances

Eq WireType

Ord WireType

Show WireType

fromWireType :: WireType -> Word32

Convert a WireType into a Word32.

toWireType :: Word32 -> Either String WireType

Convert a Word32 into a WireType or an error.

append :: Seq a -> a -> Seq a

Append a value to a Seq.