cursor

Documentation

Index

• type Cursor
• type Encoder
  • func Base64(encoding *base64.Encoding) Encoder
• type Marshaller
  • func Chain(m Marshaller, es ...Encoder) Marshaller
  • func MsgPack() Marshaller
• type Type

Types

type Cursor

type Cursor struct {
	Limit int
	Type  Type
	Value interface{}
}

type Encoder

type Encoder interface {
	// When input is nil, must return an empty string
	Encode(input []byte) ([]byte, error)

	// When encoded is an empty string, return value must be nil
	Decode(encoded []byte) ([]byte, error)
}

Used to manipulate the output of the Marshaller (convert to base64 for portability or encrypt the cursor)

func Base64

func Base64(encoding *base64.Encoding) Encoder

type Marshaller

type Marshaller interface {
	// When input is nil, must return an empty string
	Marshal(input interface{}) ([]byte, error)

	// When encoded is an empty string, return value must be nil
	Unmarshal(encoded []byte) (interface{}, error)
}

Used to transform the driver cursor representation (can be any type, most likely a literal, array or map) into a "string" (that will be converted to a portable format through the Encoder). Keep this as simple as possible

func Chain

func Chain(m Marshaller, es ...Encoder) Marshaller

func MsgPack

func MsgPack() Marshaller

type Type

type Type int

const (
	Before Type = 1 << iota
	After
)