collection

Documentation

Index

• type Collection
• type Keyed
• type Map
• type Single

Types

type Collection

type Collection interface {
	// FindAll returns matches for all the items in this Collection.
	FindAll() []types.MatchData

	// Name returns the name for the current CollectionMap
	Name() string
}

Collection are used to store VARIABLE data for transactions, this data structured is designed to store slices of data for keys Important: CollectionMaps ARE NOT concurrent safe

type Keyed

type Keyed interface {
	Collection

	// Get returns a slice of strings for a key
	Get(key string) []string

	// FindRegex returns a slice of MatchData for the regex
	FindRegex(key *regexp.Regexp) []types.MatchData

	// FindString returns a slice of MatchData for the string
	FindString(key string) []types.MatchData
}

Keyed is a Collection with elements that can be selected by key.

type Map

type Map interface {
	Keyed

	// Add a value to some key
	Add(key string, value string)

	// Set will replace the key's value with this slice
	Set(key string, values []string)

	// SetIndex will place the value under the index
	// If the index is higher than the current size of the CollectionMap
	// it will be appended
	SetIndex(key string, index int, value string)

	// Remove deletes the key from the CollectionMap
	Remove(key string)
}

Map are used to store VARIABLE data for transactions, this data structured is designed to store slices of data for keys Important: CollectionMaps ARE NOT concurrent safe

type Single

type Single interface {
	Collection

	// Get returns the value of this Single
	Get() string
}

Single is a Collection with a single element.