searchresult

Documentation

Index

• func VerifySearchType[DataType any](rType reflect.Type) error
• type Merger
  • func NewMerger() *Merger
  • func (g *Merger) Digest(reader io.Reader) (slice json.RawMessage, err error)
  • func (g *Merger) Finalize(sliceReader io.Reader) (mapReader io.Reader)
• type ResponseDataType
  • func GetResponseDataType[DataType any](rType reflect.Type) ResponseDataType
• type Typed
  • func FromSlice[DataType any](slice []*DataType) *Typed[DataType]
  • func UntypedToTyped[DataType any](untyped *Untyped) (*Typed[DataType], error)
• type Untyped

Functions

func VerifySearchType

func VerifySearchType[DataType any](rType reflect.Type) error

Types

type Merger

type Merger struct {
	// contains filtered or unexported fields
}

see the main README.md for an explanation of this file.

func NewMerger

func NewMerger() *Merger

func (*Merger) Digest

func (g *Merger) Digest(reader io.Reader) (slice json.RawMessage, err error)

func (*Merger) Finalize

func (g *Merger) Finalize(sliceReader io.Reader) (mapReader io.Reader)

type ResponseDataType

type ResponseDataType string

const (
	ResponseDataTypeUnknown ResponseDataType = ""
	ResponseDataTypeSliced  ResponseDataType = "sliced"
	ResponseDataTypeSearch  ResponseDataType = "search"
)

func GetResponseDataType

func GetResponseDataType[DataType any](rType reflect.Type) ResponseDataType

type Typed

type Typed[DataType any] struct {
	TotalCount        int
	IncompleteResults bool
	Items             []*DataType
}

func FromSlice

func FromSlice[DataType any](slice []*DataType) *Typed[DataType]

func UntypedToTyped

func UntypedToTyped[DataType any](untyped *Untyped) (*Typed[DataType], error)

type Untyped

type Untyped struct {
	TotalCount        int              `json:"total_count"`
	IncompleteResults bool             `json:"incomplete_results"`
	Items             *json.RawMessage `json:"items"`
}

see the main README.md for an explanation of this file.