collections

Documentation

Overview

Package collections contains common Hugo functionality related to collection handling.

Index

• func Append(to interface{}, from ...interface{}) (interface{}, error)
• func Slice(args ...interface{}) interface{}
• type Grouper
• type Order
• type Slicer

Functions

func Append

func Append(to interface{}, from ...interface{}) (interface{}, error)

Append appends from to a slice to and returns the resulting slice. If length of from is one and the only element is a slice of same type as to, it will be appended.

func Slice

func Slice(args ...interface{}) interface{}

Slice returns a slice of all passed arguments.

Types

type Grouper

type Grouper interface {
	Group(key interface{}, items interface{}) (interface{}, error)
}

Grouper defines a very generic way to group items by a given key.

type Order

type Order interface {
	// Ordinal is a zero-based ordinal that represents the order of an object
	// in a collection.
	Ordinal() int
}

type Slicer

type Slicer interface {
	Slice(items interface{}) (interface{}, error)
}

Slicer defines a very generic way to create a typed slice. This is used in collections.Slice template func to get types such as Pages, PageGroups etc. instead of the less useful []interface{}.