xep0059

Documentation

Index

• Constants
• Variables
• type Request
  • func NewRequestFromElement(elem stravaganza.Element) (*Request, error)
• type Result
  • func GetResultSetPage[T any](rs []T, req *Request, getID func(i T) string) ([]T, *Result, error)
  • func (r *Result) Element() stravaganza.Element

Constants

const (
	// RSMNamespace specifies XEP-0059 namespace constant value.
	RSMNamespace = "http://jabber.org/protocol/rsm"
)

Variables

var (
	// ErrPageNotFound will be returned by GetResultSetPage when page request cannot be satisfied.
	ErrPageNotFound = errors.New("page not found")
)

Types

type Request

type Request struct {
	After    string
	Before   string
	Index    int
	Max      int
	LastPage bool
}

Request represents a rsm request value.

func NewRequestFromElement

func NewRequestFromElement(elem stravaganza.Element) (*Request, error)

NewRequestFromElement returns a Request derived from an XML element.

type Result

type Result struct {
	Index    int
	First    string
	Last     string
	Count    int
	Complete bool
}

Result represents a rsm result value.

func GetResultSetPage

func GetResultSetPage[T any](rs []T, req *Request, getID func(i T) string) ([]T, *Result, error)

GetResultSetPage returns result page based on the passed request.

func (*Result) Element

func (r *Result) Element() stravaganza.Element

Element returns XML representation of a Result instance.