-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Encoders and decoders for the PostgreSQL's binary format -- -- An API for dealing with PostgreSQL's binary data format. -- -- It can be used to implement performant bindings to Postgres. E.g., -- "hasql" is based on this library. -- -- It supports all Postgres versions starting from 8.3 and is tested -- against 8.3, 9.3 and 9.5 with the integer_datetimes setting -- off and on. @package postgresql-binary @version 0.9.3 -- | Models of supported data structures according to the serialisation -- format. module PostgreSQL.Binary.Data -- | 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: -- -- 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 -> Inet InetIPv4Subnet :: IPv4 -> Netmask -> Inet InetIPv6 :: IPv6 -> Inet InetIPv6Subnet :: IPv6 -> Netmask -> Inet type IPv4 = (Word8, Word8, Word8, Word8) type IPv6 = (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16) type Netmask = Word8 maxNetmaskIPv4 :: Word8 maxNetmaskIPv6 :: Word8 -- | Address family AF_INET afInet :: Word8 -- | Address family AF_INET6 afInet6 :: Word8 ipv4Size :: Int8 ipv6Size :: Int8 isCidr :: Word8 instance GHC.Show.Show PostgreSQL.Binary.Data.Inet instance GHC.Classes.Eq PostgreSQL.Binary.Data.Inet module PostgreSQL.Binary.Decoder type Decoder = BinaryParser -- | Apply a parser to bytes. run :: BinaryParser a -> ByteString -> Either Text a int :: (Integral a, Bits a) => Decoder a float4 :: Decoder Float float8 :: Decoder Double bool :: Decoder Bool -- | BYTEA or any other type in its undecoded form. bytea_strict :: Decoder ByteString -- | BYTEA or any other type in its undecoded form. bytea_lazy :: Decoder LazyByteString -- | Any of the variable-length character types: BPCHAR, VARCHAR, NAME and -- TEXT. text_strict :: Decoder Text -- | Any of the variable-length character types: BPCHAR, VARCHAR, NAME and -- TEXT. text_lazy :: Decoder LazyText -- | A UTF-8-decoded char. char :: Decoder Char -- | Lifts a custom decoder implementation. fn :: (ByteString -> Either Text a) -> Decoder a numeric :: Decoder Scientific uuid :: Decoder UUID inet :: Decoder Inet json_ast :: Decoder Value -- | Given a function, which parses a plain UTF-8 JSON string encoded as a -- byte-array, produces a decoder. json_bytes :: (ByteString -> Either Text a) -> Decoder a jsonb_ast :: Decoder Value -- | Given a function, which parses a plain UTF-8 JSON string encoded as a -- byte-array, produces a decoder. -- -- For those wondering, yes, JSONB is encoded as plain JSON string in the -- binary format of Postgres. Sad, but true. jsonb_bytes :: (ByteString -> Either Text a) -> Decoder a -- | DATE values decoding. date :: Decoder Day -- | TIME values decoding for servers, which have -- integer_datetimes enabled. time_int :: Decoder TimeOfDay -- | TIME values decoding for servers, which don't have -- integer_datetimes enabled. time_float :: Decoder TimeOfDay -- | TIMETZ values decoding for servers, which have -- integer_datetimes enabled. timetz_int :: Decoder (TimeOfDay, TimeZone) -- | TIMETZ values decoding for servers, which don't have -- integer_datetimes enabled. timetz_float :: Decoder (TimeOfDay, TimeZone) -- | TIMESTAMP values decoding for servers, which have -- integer_datetimes enabled. timestamp_int :: Decoder LocalTime -- | TIMESTAMP values decoding for servers, which don't have -- integer_datetimes enabled. timestamp_float :: Decoder LocalTime -- | TIMESTAMP values decoding for servers, which have -- integer_datetimes enabled. timestamptz_int :: Decoder UTCTime -- | TIMESTAMP values decoding for servers, which don't have -- integer_datetimes enabled. timestamptz_float :: Decoder UTCTime -- | INTERVAL values decoding for servers, which don't have -- integer_datetimes enabled. interval_int :: Decoder DiffTime -- | INTERVAL values decoding for servers, which have -- integer_datetimes enabled. interval_float :: Decoder DiffTime -- | An efficient generic array decoder, which constructs the result value -- in place while parsing. -- -- Here's how you can use it to produce a specific array value decoder: -- -- 
--   x :: Decoder [ [ Text ] ]
--   x =
--     array (arrayDimension replicateM (fmap catMaybes (arrayDimension replicateM (arrayValue text))))
--
data ArrayDecoder a -- | Unlift an ArrayDecoder to a value Decoder. array :: ArrayDecoder a -> Decoder a -- | A function for parsing a dimension of an array. Provides support for -- multi-dimensional arrays. -- -- Accepts: -- -- arrayDimension :: (forall m. Monad m => Int -> m a -> m b) -> ArrayDecoder a -> ArrayDecoder b -- | Lift a value Decoder into ArrayDecoder for parsing of -- nullable leaf values. arrayValue :: Decoder a -> ArrayDecoder (Maybe a) -- | Lift a value Decoder into ArrayDecoder for parsing of -- non-nullable leaf values. arrayNonNullValue :: Decoder a -> ArrayDecoder a data CompositeDecoder a -- | Unlift a CompositeDecoder to a value Decoder. composite :: CompositeDecoder a -> Decoder a -- | Lift a value Decoder into CompositeDecoder. compositeValue :: Decoder a -> CompositeDecoder (Maybe a) -- | Lift a non-nullable value Decoder into CompositeDecoder. compositeNonNullValue :: Decoder a -> CompositeDecoder a -- | A function for generic in place parsing of an HStore value. -- -- Accepts: -- -- -- -- Here's how you can use it to produce a parser to list: -- -- 
--   hstoreAsList :: Decoder [ ( Text , Maybe Text ) ]
--   hstoreAsList =
--     hstore replicateM text text
--
hstore :: (forall m. Monad m => Int -> m (k, Maybe v) -> m r) -> Decoder k -> Decoder v -> Decoder r -- | Given a partial mapping from text to value, produces a decoder of that -- value. enum :: (Text -> Maybe a) -> Decoder a instance GHC.Base.Functor PostgreSQL.Binary.Decoder.ArrayDecoder instance GHC.Base.Monad PostgreSQL.Binary.Decoder.CompositeDecoder instance GHC.Base.Applicative PostgreSQL.Binary.Decoder.CompositeDecoder instance GHC.Base.Functor PostgreSQL.Binary.Decoder.CompositeDecoder module PostgreSQL.Binary.Encoder run :: Encoder a -> a -> ByteString type Encoder a = a -> Builder int2_int16 :: Encoder Int16 int2_word16 :: Encoder Word16 int4_int32 :: Encoder Int32 int4_word32 :: Encoder Word32 int8_int64 :: Encoder Int64 int8_word64 :: Encoder Word64 float4 :: Encoder Float float8 :: Encoder Double composite :: Encoder Composite bool :: Encoder Bool numeric :: Encoder Scientific uuid :: Encoder UUID inet :: Encoder Inet json_ast :: Encoder Value json_bytes :: Encoder ByteString jsonb_ast :: Encoder Value jsonb_bytes :: Encoder ByteString -- | A UTF-8-encoded char. -- -- Note that since it's UTF-8-encoded not the "char" but the "text" OID -- should be used with it. char :: Encoder Char text_strict :: Encoder Text text_lazy :: Encoder Text bytea_strict :: Encoder ByteString bytea_lazy :: Encoder ByteString date :: Encoder Day time_int :: Encoder TimeOfDay time_float :: Encoder TimeOfDay timetz_int :: Encoder (TimeOfDay, TimeZone) timetz_float :: Encoder (TimeOfDay, TimeZone) timestamp_int :: Encoder LocalTime timestamp_float :: Encoder LocalTime timestamptz_int :: Encoder UTCTime timestamptz_float :: Encoder UTCTime interval_int :: Encoder DiffTime interval_float :: Encoder DiffTime -- | A polymorphic in-place HSTORE encoder. -- -- Accepts: -- -- -- -- Here's how you can use it to produce a specific encoder: -- -- 
--   hashMapHStore :: Encoder (Data.HashMap.Strict.HashMap Text (Maybe Text))
--   hashMapHStore =
--     hstore foldl'
--
hstore :: (forall a. (a -> (Text, Maybe Text) -> a) -> a -> b -> a) -> Encoder b hstoreRep :: Encoder HStore array :: Word32 -> ArrayEncoder a -> Encoder a data ArrayEncoder a arrayValue :: Encoder a -> ArrayEncoder a arrayNullableValue :: Encoder a -> ArrayEncoder (Maybe a) arrayDimension :: (forall a. (a -> b -> a) -> a -> c -> a) -> ArrayEncoder b -> ArrayEncoder c arrayRep :: Encoder Array -- | Given a function, which maps the value into the textual enum label -- from the DB side, produces an encoder of that value enum :: (a -> Text) -> Encoder a