api

Documentation

Index

• Constants
• func From(f string) (int64, error)
• func MatchType(ssurt string, matchType string) string
• func To(t string) (int64, error)
• type CoreAPI
  • func ClosestAPI(closest string, u *url.Url) *CoreAPI
  • func Parse(r *http.Request) (*CoreAPI, error)
  • func (capi *CoreAPI) Url() *url.Url
• type DateRange
  • func NewDateRange(fromstr string, tostr string) (*DateRange, error)
  • func (d *DateRange) Contains(ts int64) bool
  • func (d *DateRange) ContainsStr(ts string) (bool, error)
  • func (d *DateRange) ContainsTime(t time.Time) (bool, error)
• type Filter
  • func ParseFilter(filterStrings []string, remap map[string]string) Filter
  • func (f Filter) Eval(c *schema.Cdx) bool
• type Op
• type SearchAPI
  • func (c SearchAPI) Closest() string
  • func (c SearchAPI) DateRange() index.DateRange
  • func (c SearchAPI) Filter() index.Filter
  • func (c SearchAPI) Key() string
  • func (c SearchAPI) Keys() []string
  • func (c SearchAPI) Limit() int
  • func (c SearchAPI) MatchType() string
  • func (c SearchAPI) Sort() index.Sort

Constants

const (
	SortClosest = "closest"
	SortReverse = "reverse"
)

const (
	MatchTypeExact  = "exact"
	MatchTypePrefix = "prefix"
	MatchTypeHost   = "host"
	MatchTypeDomain = "domain"
)

const (
	OutputCdxj = "cdxj"
	OutputJson = "json"
)

Functions

func From

func From(f string) (int64, error)

From parses string f to unix time according to https://pywb.readthedocs.io/en/latest/manual/cdxserver_api.html#from-to:

func MatchType

func MatchType(ssurt string, matchType string) string

func To

func To(t string) (int64, error)

To parses string t to unix time according to https://pywb.readthedocs.io/en/latest/manual/cdxserver_api.html#from-to:

Types

type CoreAPI

type CoreAPI struct {
	Collection string
	Urls       []*url.Url
	FromTo     *DateRange
	MatchType  string
	Limit      int
	Sort       string
	Closest    string
	Output     string
	Filter     []string
	Fields     []string
}

CoreAPI implements a subset of https://pywb.readthedocs.io/en/latest/manual/cdxserver_api.html.

func ClosestAPI

func ClosestAPI(closest string, u *url.Url) *CoreAPI

func Parse

func Parse(r *http.Request) (*CoreAPI, error)

Parse parses the request r into a *CoreAPI.

func (*CoreAPI) Url

func (capi *CoreAPI) Url() *url.Url

type DateRange

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

func NewDateRange

func NewDateRange(fromstr string, tostr string) (*DateRange, error)

func (*DateRange) Contains

func (d *DateRange) Contains(ts int64) bool

func (*DateRange) ContainsStr

func (d *DateRange) ContainsStr(ts string) (bool, error)

ContainsStr returns true if the timestamp ts contained by the bounds defined by the DateRange d. input 'ts' is 'trusted' and does not have the same parsing complexity as a From or To string

func (*DateRange) ContainsTime

func (d *DateRange) ContainsTime(t time.Time) (bool, error)

ContainsTime returns true if time.Time t is contained by the bounds defined by the DateRange d.

type Filter

type Filter []filter

func ParseFilter

func ParseFilter(filterStrings []string, remap map[string]string) Filter

func (Filter) Eval

func (f Filter) Eval(c *schema.Cdx) bool

type Op

type Op int

const (
	OpContains Op = iota
	OpExact
	OpRegexp
)

type SearchAPI

type SearchAPI struct {
	*CoreAPI
	FilterMap map[string]string
}

func (SearchAPI) Closest

func (c SearchAPI) Closest() string

func (SearchAPI) DateRange

func (c SearchAPI) DateRange() index.DateRange

func (SearchAPI) Filter

func (c SearchAPI) Filter() index.Filter

func (SearchAPI) Key

func (c SearchAPI) Key() string

func (SearchAPI) Keys

func (c SearchAPI) Keys() []string

func (SearchAPI) Limit

func (c SearchAPI) Limit() int

func (SearchAPI) MatchType

func (c SearchAPI) MatchType() string

func (SearchAPI) Sort

func (c SearchAPI) Sort() index.Sort