2
0

Add documentation

This commit is contained in:
Jack Christensen
2022-03-19 17:01:12 -05:00
parent 72b72b9ae9
commit 8c18d7808b
6 changed files with 132 additions and 240 deletions
+2 -1
View File
@@ -132,6 +132,7 @@ const (
BinaryFormatCode = 1
)
// A Codec converts between Go and PostgreSQL values.
type Codec interface {
// FormatSupported returns true if the format is supported.
FormatSupported(int16) bool
@@ -139,7 +140,7 @@ type Codec interface {
// PreferredFormat returns the preferred format.
PreferredFormat() int16
// PlanEncode returns an Encode plan for encoding value into PostgreSQL format for oid and format. If no plan can be
// PlanEncode returns an EncodePlan for encoding value into PostgreSQL format for oid and format. If no plan can be
// found then nil is returned.
PlanEncode(m *Map, oid uint32, format int16, value interface{}) EncodePlan