...

Package models

import "github.com/illuscio-dev/spantools-go/models"
Overview
Index

Overview ▾

Shared models for Spanreed ecosystem.

type PagingReq

Paging parameters for request.

type PagingReq struct {
    // How far to offset the page.
    Offset int
    // Maximum item count to return.
    Limit int
}

func PagingReqFromParams

func PagingReqFromParams(
    headers valueFetcher, defaultLimit int,
) (pagingReq *PagingReq, err error)

Generates a PagingReq object from request parameters.

func (*PagingReq) ToParams

func (pagingReq *PagingReq) ToParams(params valueSetter)

Dumps paging information to request URL params.

type PagingResp

type PagingResp struct {
    *PagingReq
    TotalItems  int
    TotalPages  int
    CurrentPage int
    Next        string
    Previous    string
}

func PagingRespFromHeaders

func PagingRespFromHeaders(
    params valueFetcher, defaultLimit int,
) (pagingResp *PagingResp, err error)

PagingRespFromHeaders generates a PagingResp object from response headers.

func (*PagingResp) ToHeaders

func (pagingResp *PagingResp) ToHeaders(headers valueSetter)

type SpanError

Alias to errors_api.SpanError

type SpanError = spanerrors.SpanError

type SpanErrorType

Alias to errors_api.SpanErrorType

type SpanErrorType = spanerrors.SpanErrorType