packstream-bolt-0.1.0.0: PackStream binary serialization format
Safe HaskellNone
LanguageGHC2021

Data.PackStream.Integer

Description

PackStream integer type covering the full [-2^63, 2^64-1] range.

Synopsis

Documentation

data PSInteger Source #

Integer type that represents the value range of integral numbers in PackStream; i.e. \( \left[ -2^{63}, 2^{64}-1 \right] \). In other words, PSInteger provides the union of the value ranges of Word64 and Int64.

This type can be unboxed (i.e. via {-# UNPACK #-}).

Instances

Instances details
Bounded PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

minBound :: PSInteger #

maxBound :: PSInteger #

Enum PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

succ :: PSInteger -> PSInteger #

pred :: PSInteger -> PSInteger #

toEnum :: Int -> PSInteger #

fromEnum :: PSInteger -> Int #

enumFrom :: PSInteger -> [PSInteger] #

enumFromThen :: PSInteger -> PSInteger -> [PSInteger] #

enumFromTo :: PSInteger -> PSInteger -> [PSInteger] #

enumFromThenTo :: PSInteger -> PSInteger -> PSInteger -> [PSInteger] #

Generic PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Associated Types

type Rep PSInteger 
Instance details

Defined in Data.PackStream.Integer

type Rep PSInteger = D1 ('MetaData "PSInteger" "Data.PackStream.Integer" "packstream-bolt-0.1.0.0-8Vg7PYLfGT8Gdt79ulKaPg" 'False) (C1 ('MetaCons "PSInteger" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int64)))

Methods

from :: PSInteger -> Rep PSInteger x #

to :: Rep PSInteger x -> PSInteger #

Num PSInteger Source #

This instance will throw the respective arithmetic Underflow and Overflow exception if the range of PSInteger is exceeded.

Instance details

Defined in Data.PackStream.Integer

Methods

(+) :: PSInteger -> PSInteger -> PSInteger #

(-) :: PSInteger -> PSInteger -> PSInteger #

(*) :: PSInteger -> PSInteger -> PSInteger #

negate :: PSInteger -> PSInteger #

abs :: PSInteger -> PSInteger #

signum :: PSInteger -> PSInteger #

fromInteger :: Integer -> PSInteger #

Read PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

readsPrec :: Int -> ReadS PSInteger #

readList :: ReadS [PSInteger] #

readPrec :: ReadPrec PSInteger #

readListPrec :: ReadPrec [PSInteger] #

Integral PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

quot :: PSInteger -> PSInteger -> PSInteger #

rem :: PSInteger -> PSInteger -> PSInteger #

div :: PSInteger -> PSInteger -> PSInteger #

mod :: PSInteger -> PSInteger -> PSInteger #

quotRem :: PSInteger -> PSInteger -> (PSInteger, PSInteger) #

divMod :: PSInteger -> PSInteger -> (PSInteger, PSInteger) #

toInteger :: PSInteger -> Integer #

Real PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

toRational :: PSInteger -> Rational #

Show PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

showsPrec :: Int -> PSInteger -> ShowS #

show :: PSInteger -> String #

showList :: [PSInteger] -> ShowS #

NFData PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

rnf :: PSInteger -> () #

Eq PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

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

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

Ord PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

compare :: PSInteger -> PSInteger -> Ordering #

(<) :: PSInteger -> PSInteger -> Bool #

(<=) :: PSInteger -> PSInteger -> Bool #

(>) :: PSInteger -> PSInteger -> Bool #

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

max :: PSInteger -> PSInteger -> PSInteger #

min :: PSInteger -> PSInteger -> PSInteger #

PackStream PSInteger Source # 
Instance details

Defined in Data.PackStream.Ps

Methods

toPs :: PSInteger -> Ps Source #

toBinary :: PSInteger -> Put Source #

fromPs :: Ps -> Result PSInteger Source #

Persist PSInteger Source #

This Persist instance encodes/decodes to/from PackStream format

When serializing PSIntegers via get the shortest encoding is used. Moreoever, for non-negative integers the unsigned encoding is always used.

Deserialization via get will only fail if a non-integer PackStream tag is encountered.

Instance details

Defined in Data.PackStream.Integer

Methods

put :: PSInteger -> Put () #

get :: Get PSInteger #

unsafePut :: PSInteger -> Put () #

unsafeGet :: Get PSInteger #

TextShow PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

showbPrec :: Int -> PSInteger -> Builder #

showb :: PSInteger -> Builder #

showbList :: [PSInteger] -> Builder #

showtPrec :: Int -> PSInteger -> Text #

showt :: PSInteger -> Text #

showtList :: [PSInteger] -> Text #

showtlPrec :: Int -> PSInteger -> Text #

showtl :: PSInteger -> Text #

showtlList :: [PSInteger] -> Text #

type Rep PSInteger Source # 
Instance details

Defined in Data.PackStream.Integer

type Rep PSInteger = D1 ('MetaData "PSInteger" "Data.PackStream.Integer" "packstream-bolt-0.1.0.0-8Vg7PYLfGT8Gdt79ulKaPg" 'False) (C1 ('MetaCons "PSInteger" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int64)))

class ToPSInteger a where Source #

Types that can be losslessly converted to PSInteger.

Methods

toPSInteger :: a -> PSInteger Source #

Instances

Instances details
ToPSInteger Int16 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

toPSInteger :: Int16 -> PSInteger Source #

ToPSInteger Int32 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

toPSInteger :: Int32 -> PSInteger Source #

ToPSInteger Int64 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

toPSInteger :: Int64 -> PSInteger Source #

ToPSInteger Int8 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

toPSInteger :: Int8 -> PSInteger Source #

ToPSInteger Word16 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

toPSInteger :: Word16 -> PSInteger Source #

ToPSInteger Word32 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

toPSInteger :: Word32 -> PSInteger Source #

ToPSInteger Word8 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

toPSInteger :: Word8 -> PSInteger Source #

ToPSInteger Int Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

toPSInteger :: Int -> PSInteger Source #

class FromPSInteger a where Source #

Convert a PSInteger value to something else if possible

The instances for FromPSInteger are supposed to be consistent with the respective instances for ToPSInteger, e.g.

fromPSInteger . toPSInteger == Just

Methods

fromPSInteger :: PSInteger -> Maybe a Source #

Instances

Instances details
FromPSInteger Int16 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

fromPSInteger :: PSInteger -> Maybe Int16 Source #

FromPSInteger Int32 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

fromPSInteger :: PSInteger -> Maybe Int32 Source #

FromPSInteger Int64 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

fromPSInteger :: PSInteger -> Maybe Int64 Source #

FromPSInteger Int8 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

fromPSInteger :: PSInteger -> Maybe Int8 Source #

FromPSInteger Word16 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

fromPSInteger :: PSInteger -> Maybe Word16 Source #

FromPSInteger Word32 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

fromPSInteger :: PSInteger -> Maybe Word32 Source #

FromPSInteger Word8 Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

fromPSInteger :: PSInteger -> Maybe Word8 Source #

FromPSInteger Int Source # 
Instance details

Defined in Data.PackStream.Integer

Methods

fromPSInteger :: PSInteger -> Maybe Int Source #

fromIntegerTry :: Integer -> Either ArithException PSInteger Source #

Try to convert Integer into PSInteger

Will return Left Underflow or Left Overflow respectively if out of range

Internal helper

tryPSInteger :: Word8 -> (PSInteger -> a) -> Get a -> Get a Source #

Try to decode a PSInteger given a tag byte, applying f on success or falling through to the continuation.