api

Documentation

Index

• Constants
• type DateRange
  • func NewDateRange(fromstr string, tostr string) (*DateRange, error)
  • func (d *DateRange) Contains(ts int64) bool
  • func (d *DateRange) String() string
• type Filter
  • func ParseFilter(filterStrings []string, remap map[string]string) Filter
  • func (f Filter) Eval(c *schema.Cdx) bool
• type Op
• type SearchRequest
  • func ClosestRequest(closest string, url *whatwgUrl.Url) *SearchRequest
  • func Parse(values url.Values) (req *SearchRequest, err error)
  • func (c *SearchRequest) Closest() string
  • func (c *SearchRequest) DateRange() index.DateRange
  • func (c *SearchRequest) Fields() []string
  • func (c *SearchRequest) Filter() index.Filter
  • func (c *SearchRequest) Limit() int
  • func (c *SearchRequest) MatchType() index.MatchType
  • func (c *SearchRequest) Output() string
  • func (c *SearchRequest) Parse(values url.Values) error
  • func (c *SearchRequest) SetLimit(limit int)
  • func (c *SearchRequest) SetMatchType(matchType index.MatchType)
  • func (c *SearchRequest) Sort() index.Sort
  • func (c *SearchRequest) Ssurt() string
  • func (c *SearchRequest) Url() *whatwgUrl.Url

Constants

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

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

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

const (
	ParamMatchType = "matchType"
	ParamUrl       = "url"
	ParamFrom      = "from"
	ParamTo        = "to"
	ParamLimit     = "limit"
	ParamSort      = "sort"
	ParamClosest   = "closest"
	ParamOutput    = "output"
	ParamFilter    = "filter"
	ParamFields    = "fields"
)

Types

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) String

func (d *DateRange) String() string

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 SearchRequest

type SearchRequest struct {
	FilterMap map[string]string

	url.Values
	// contains filtered or unexported fields
}

func ClosestRequest

func ClosestRequest(closest string, url *whatwgUrl.Url) *SearchRequest

func Parse

func Parse(values url.Values) (req *SearchRequest, err error)

func (*SearchRequest) Closest

func (c *SearchRequest) Closest() string

func (*SearchRequest) DateRange

func (c *SearchRequest) DateRange() index.DateRange

func (*SearchRequest) Fields

func (c *SearchRequest) Fields() []string

func (*SearchRequest) Filter

func (c *SearchRequest) Filter() index.Filter

func (*SearchRequest) Limit

func (c *SearchRequest) Limit() int

func (*SearchRequest) MatchType

func (c *SearchRequest) MatchType() index.MatchType

func (*SearchRequest) Output

func (c *SearchRequest) Output() string

func (*SearchRequest) Parse

func (c *SearchRequest) Parse(values url.Values) error

func (*SearchRequest) SetLimit

func (c *SearchRequest) SetLimit(limit int)

func (*SearchRequest) SetMatchType

func (c *SearchRequest) SetMatchType(matchType index.MatchType)

func (*SearchRequest) Sort

func (c *SearchRequest) Sort() index.Sort

func (*SearchRequest) Ssurt

func (c *SearchRequest) Ssurt() string

func (*SearchRequest) Url

func (c *SearchRequest) Url() *whatwgUrl.Url