Data.hs

-- |
-- Models of supported data structures according to the serialisation format.
module PostgreSQL.Binary.Data where

import PostgreSQL.Binary.Prelude


-- | 
-- A representation of a data serializable to the PostgreSQL array binary format.
-- 
-- Consists of a vector of dimensions, a vector of encoded elements,
-- a flag specifying, whether it contains any nulls, and an oid.
type Array =
  (Vector ArrayDimension, Vector Content, Bool, OID)

-- | 
-- A width and a lower bound.
-- 
-- Currently the lower bound is only allowed to have a value of @1@.
type ArrayDimension =
  (Word32, Word32)

-- |
-- An encoded value. 'Nothing' if it represents a @NULL@.
type Content =
  Maybe ByteString

-- |
-- A Postgres OID of a type.
type OID =
  Word32

-- |
-- A representation of a composite Postgres data (Record or Row).
type Composite =
  Vector (OID, Content)

-- |
-- HStore.
type HStore =
  Vector (ByteString, Content)

-- |
-- The four components of UUID.
type UUID =
  (Word32, Word32, Word32, Word32)

-- |
-- Representation of the PostgreSQL Numeric encoding.
-- 
-- Consists of the following components:
-- 
-- * Point index
-- * Sign code
-- * Components
-- 
type Numeric =
  (Int16, Word16, Vector Int16)

-- |
-- Representation of the PostgreSQL Network Address Type @inet@.
--
-- The Inet type holds an IPv4 or IPv6 host address, and optionally its subnet.
-- The subnet is represented by the number of network address bits present in the host address (the "netmask").
-- If the subnet portion is missing, the netmask is 32 for IPv4 and 128 for IPv6.
data Inet
  = InetIPv4 IPv4
  | InetIPv4Subnet IPv4 Netmask
  | InetIPv6 IPv6
  | InetIPv6Subnet IPv6 Netmask
  deriving (Eq, Show)

type IPv4 = (Word8, Word8, Word8, Word8)

type IPv6 = (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16)

type Netmask = Word8

maxNetmaskIPv4 :: Word8
maxNetmaskIPv4 = 32

maxNetmaskIPv6 :: Word8
maxNetmaskIPv6 = 128

-- | Address family AF_INET
afInet :: Word8
afInet = 2

-- | Address family AF_INET6
afInet6 :: Word8
afInet6 = 3

ipv4Size :: Int8
ipv4Size = 4

ipv6Size :: Int8
ipv6Size = 16

isCidr :: Word8
isCidr = 0