Module pg_types

This module defines the pg_types behaviour.
Required callback functions: init/1, encode/2, decode/2, type_spec/0.

Data Types

encoding_error()

encoding_error() = #{error := atom(), value := term(), type_info := type_info()}

oid()

oid() = integer()

parameters()

parameters() = #{binary() => binary()}

type_info()

type_info() = #type_info{}

Function Index

decode/2
decode/3
encode/2
encode/3
format_error/1
lookup_type_info/2
update/3
update_map/3

Function Details

decode/2

decode(Value::binary(), TypeInfo::type_info()) -> term()

decode/3

decode(Pool::atom(), Value::binary(), Oid::oid()) -> term()

encode/2

encode(Value::term(), TypeInfo::type_info()) -> iodata()

encode/3

encode(Pool::atom(), Value::any(), Oid::oid()) -> iodata()

format_error/1

format_error(Error::encoding_error() | term()) -> string()

lookup_type_info/2

lookup_type_info(Pool, Oid) -> any()

update/3

update(Pool::atom(), TypeInfos::[type_info()], Parameters::map()) -> ok

update_map/3

update_map(TypeInfos::[type_info()], Parameters::map(), ToUpdate::map()) -> map()


Generated by EDoc