xquery

Documentation

Index

• func DecodeCursor(in string, m interface{}) error
• func EncodeCursor(m interface{}) (string, error)
• type CursorEntry
  • func (c *CursorEntry) IsNull() bool
  • func (c CursorEntry) MarshalBinary() ([]byte, error)
  • func (c *CursorEntry) UnmarshalBinary(in []byte) error
• type CursorType
  • func (c CursorType) IsValid() bool
• type Cursors

Functions

func DecodeCursor

func DecodeCursor(in string, m interface{}) error

DecodeCursor decodes the cursor entry input.

func EncodeCursor

func EncodeCursor(m interface{}) (string, error)

EncodeCursor encodes the cursor into a string.

Types

type CursorEntry

type CursorEntry struct {
	Type  CursorType
	Value string
}

CursorEntry is the entry used by the cursor.

func (*CursorEntry) IsNull

func (c *CursorEntry) IsNull() bool

IsNull checks if the cursor entry is null.

func (CursorEntry) MarshalBinary

func (c CursorEntry) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler interface.

func (*CursorEntry) UnmarshalBinary

func (c *CursorEntry) UnmarshalBinary(in []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler interface.

type CursorType

type CursorType uint8

CursorType is the enumerator that defines the type of the cursor.

const (
	CursorTypeUndefined CursorType = iota
	CursorTypeThis
	CursorTypePrev
	CursorTypeNext
	CursorTypeFirst
	CursorTypeLast
)

Cursors enumerated types. There are 5 defined cursor types:

• This -
• Prev -
• Next -
• First -
• Last -

func (CursorType) IsValid

func (c CursorType) IsValid() bool

IsValid checks if the provided cursor type is valid.

type Cursors

type Cursors struct {
	This  string `json:"this,omitempty"`
	Prev  string `json:"prev,omitempty"`
	Next  string `json:"next,omitempty"`
	First string `json:"first,omitempty"`
	Last  string `json:"last,omitempty"`
}

Cursors is the structure that contains all the page cursors.