pagerange

Documentation

Index

• Constants
• Variables
• type Range
  • func MustNew(lower, upper int) Range
  • func MustSingle(n int) Range
  • func New(lower, upper int) (Range, error)
  • func Single(n int) (Range, error)
  • func (r Range) String() string
  • func (r Range) Validate() error

Constants

const Last int = math.MaxInt

Variables

var All = MustNew(1, Last)

Types

type Range

type Range struct {
	Lower, Upper int
}

Ranges are one-based and include the last page (e.g. {1,3} means page 1, 2 and 3). Upper may be Last to indicate all pages from lower to the last. If both values are Last only the last page is covered.

func MustNew

func MustNew(lower, upper int) Range

MustNew is like New but panics if the range is invalid.

func MustSingle

func MustSingle(n int) Range

MustSingle is like Single but panics if construction fails.

func New

func New(lower, upper int) (Range, error)

New creates a new page range.

func Single

func Single(n int) (Range, error)

Single returns a range for a single page.

func (Range) String

func (r Range) String() string

func (Range) Validate

func (r Range) Validate() error

Validate checks whether the range is valid.