collections

package
Version: v0.45.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 25, 2018 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Namespace

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

Namespace provides template functions for the "collections" namespace.

func New

func New(deps *deps.Deps) *Namespace

New returns a new instance of the collections-namespaced template functions.

func (*Namespace) After

func (ns *Namespace) After(index interface{}, seq interface{}) (interface{}, error)

After returns all the items after the first N in a rangeable list.

func (*Namespace) Apply

func (ns *Namespace) Apply(seq interface{}, fname string, args ...interface{}) (interface{}, error)

Apply takes a map, array, or slice and returns a new slice with the function fname applied over it.

func (*Namespace) Delimit

func (ns *Namespace) Delimit(seq, delimiter interface{}, last ...interface{}) (template.HTML, error)

Delimit takes a given sequence and returns a delimited HTML string. If last is passed to the function, it will be used as the final delimiter.

func (*Namespace) Dictionary

func (ns *Namespace) Dictionary(values ...interface{}) (map[string]interface{}, error)

Dictionary creates a map[string]interface{} from the given parameters by walking the parameters and treating them as key-value pairs. The number of parameters must be even.

func (*Namespace) EchoParam

func (ns *Namespace) EchoParam(a, key interface{}) interface{}

EchoParam returns a given value if it is set; otherwise, it returns an empty string.

func (*Namespace) First

func (ns *Namespace) First(limit interface{}, seq interface{}) (interface{}, error)

First returns the first N items in a rangeable list.

func (*Namespace) In

func (ns *Namespace) In(l interface{}, v interface{}) bool

In returns whether v is in the set l. l may be an array or slice.

func (*Namespace) Index

func (ns *Namespace) Index(item interface{}, indices ...interface{}) (interface{}, error)

Index returns the result of indexing its first argument by the following arguments. Thus "index x 1 2 3" is, in Go syntax, x[1][2][3]. Each indexed item must be a map, slice, or array.

Copied from Go stdlib src/text/template/funcs.go.

We deviate from the stdlib due to https://github.com/golang/go/issues/14751.

TODO(moorereason): merge upstream changes.

func (*Namespace) Intersect

func (ns *Namespace) Intersect(l1, l2 interface{}) (interface{}, error)

Intersect returns the common elements in the given sets, l1 and l2. l1 and l2 must be of the same type and may be either arrays or slices.

func (*Namespace) IsSet

func (ns *Namespace) IsSet(a interface{}, key interface{}) (bool, error)

IsSet returns whether a given array, channel, slice, or map has a key defined.

func (*Namespace) KeyVals added in v0.27.1

func (ns *Namespace) KeyVals(key interface{}, vals ...interface{}) (types.KeyValues, error)

KeyVals creates a key and values wrapper.

func (*Namespace) Last

func (ns *Namespace) Last(limit interface{}, seq interface{}) (interface{}, error)

Last returns the last N items in a rangeable list.

func (*Namespace) NewScratch added in v0.45.1

func (ns *Namespace) NewScratch() *maps.Scratch

NewScratch creates a new Scratch which can be used to store values in a thread safe way.

func (*Namespace) Querify

func (ns *Namespace) Querify(params ...interface{}) (string, error)

Querify encodes the given parameters in URL-encoded form ("bar=baz&foo=quux") sorted by key.

func (*Namespace) Seq

func (ns *Namespace) Seq(args ...interface{}) ([]int, error)

Seq creates a sequence of integers. It's named and used as GNU's seq.

Examples:

3 => 1, 2, 3
1 2 4 => 1, 3
-3 => -1, -2, -3
1 4 => 1, 2, 3, 4
1 -2 => 1, 0, -1, -2

func (*Namespace) Shuffle

func (ns *Namespace) Shuffle(seq interface{}) (interface{}, error)

Shuffle returns the given rangeable list in a randomised order.

func (*Namespace) Slice

func (ns *Namespace) Slice(args ...interface{}) []interface{}

Slice returns a slice of all passed arguments.

func (*Namespace) Sort

func (ns *Namespace) Sort(seq interface{}, args ...interface{}) (interface{}, error)

Sort returns a sorted sequence.

func (*Namespace) Union

func (ns *Namespace) Union(l1, l2 interface{}) (interface{}, error)

Union returns the union of the given sets, l1 and l2. l1 and l2 must be of the same type and may be either arrays or slices. If l1 and l2 aren't of the same type then l1 will be returned. If either l1 or l2 is nil then the non-nil list will be returned.

func (*Namespace) Uniq

func (ns *Namespace) Uniq(l interface{}) (interface{}, error)

Uniq takes in a slice or array and returns a slice with subsequent duplicate elements removed.

func (*Namespace) Where

func (ns *Namespace) Where(seq, key interface{}, args ...interface{}) (interface{}, error)

Where returns a filtered subset of a given data type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL