filter

Documentation

Index

• Variables
• type Filter
  • func New(opts ...Option) Filter
  • func (f Filter) Param(n string) (interface{}, bool)
• type Option
  • func WithLimit(r Range) Option
  • func WithOrder(o Order) Option
  • func WithTimeframe(t Timeframe) Option
• type Order
• type Range
• type Timeframe
  • func NewSince(f time.Time) Timeframe
  • func NewTimeframe(f, t time.Time) Timeframe
  • func NewUntil(t time.Time) Timeframe
  • func (t Timeframe) CompareDuration(d time.Duration) int
  • func (t Timeframe) Contains(a time.Time) bool
  • func (t Timeframe) Duration() time.Duration
  • func (t Timeframe) Format(layout string) string
  • func (t Timeframe) IsFinite() bool
  • func (t Timeframe) String() string

Variables

var Infinite = Timeframe{}

A timeframe with no bounds, representing all time

var ZeroRange = Range{}

Types

type Filter

type Filter struct {
	Limit     Range
	Order     Order
	Timeframe Timeframe
	Params    map[string]interface{}
}

func New

func New(opts ...Option) Filter

func (Filter) Param

func (f Filter) Param(n string) (interface{}, bool)

type Option

type Option func(Filter) Filter

func WithLimit

func WithLimit(r Range) Option

func WithOrder

func WithOrder(o Order) Option

func WithTimeframe

func WithTimeframe(t Timeframe) Option

type Order

type Order int

const (
	Ascending Order = iota
	Descending
)

type Range

type Range struct {
	Offset int `json:"offset"`
	Length int `json:"length"`
}

type Timeframe

type Timeframe struct {
	Since *time.Time `json:"since"`
	Until *time.Time `json:"until"`
}

A timeframe

func NewSince

func NewSince(f time.Time) Timeframe

Create a timeframe from the specified time to +inf

func NewTimeframe

func NewTimeframe(f, t time.Time) Timeframe

Create a timeframe

func NewUntil

func NewUntil(t time.Time) Timeframe

Create a timeframe from -inf to the specified time

func (Timeframe) CompareDuration

func (t Timeframe) CompareDuration(d time.Duration) int

CompareDuration compares the duration between t.Since and t.Until with the given duration

func (Timeframe) Contains

func (t Timeframe) Contains(a time.Time) bool

Determine if the timeframe contains the specified time. Timeframes are inclusive on the lower bound and exclusive on the upper bound.

func (Timeframe) Duration

func (t Timeframe) Duration() time.Duration

What is the duration of the timeframe. If a timeframe is not bounded on both ends, the duration is infinite, which is expressed as a negative value. If Until is before Since, the value will also be negative, this is a logically invalid state that is interpreted as the timeframe being unbounded.

func (Timeframe) Format

func (t Timeframe) Format(layout string) string

func (Timeframe) IsFinite

func (t Timeframe) IsFinite() bool

Is a timeframe finite (is bounded)

func (Timeframe) String

func (t Timeframe) String() string