state

Documentation

Overview

Copyright © 2024 JR team

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• type CSV
• type CSVMap
• type Execution
• type SharedState
  • func GetSharedState() *SharedState
  • func (st *SharedState) AddValueToList(key string, value any)
  • func (st *SharedState) Counter(c string, start int, step int) int
  • func (st *SharedState) FromCSV(c string) string
  • func (st *SharedState) GetValueFromListAtIndex(s string, index int) any
  • func (st *SharedState) RandomNValuesFromList(s string, n int) []any
  • func (st *SharedState) RandomValueFromList(s string) any
  • func (st *SharedState) SetCSV(csv CSVMap)
  • func (st *SharedState) Value(key string) any
• type State
  • func NewState() *State
  • func (s *State) AddHeader(key string, value string) string
  • func (s *State) SetKey(key string) string

Types

type CSV

type CSV map[string]string

type CSVMap

type CSVMap map[int]CSV

type Execution

type Execution struct {
	Start                     time.Time
	GeneratedObjects          uint64
	GeneratedBytes            uint64
	ExpectedObjects           int64
	CurrentIterationLoopIndex int
}

type SharedState

type SharedState struct {
	Execution *Execution
	Locale    string
	Counters  sync.Map

	Ctx sync.Map

	List sync.Map

	CSVMap CSVMap

	LastIndex    int
	CountryIndex int
	CityIndex    int
	// contains filtered or unexported fields
}

SharedState is the object passed on the templates which contains all the needed details.

func GetSharedState

func GetSharedState() *SharedState

func (*SharedState) AddValueToList

func (st *SharedState) AddValueToList(key string, value any)

func (*SharedState) Counter

func (st *SharedState) Counter(c string, start int, step int) int

func (*SharedState) FromCSV

func (st *SharedState) FromCSV(c string) string

func (*SharedState) GetValueFromListAtIndex

func (st *SharedState) GetValueFromListAtIndex(s string, index int) any

func (*SharedState) RandomNValuesFromList

func (st *SharedState) RandomNValuesFromList(s string, n int) []any

RandomNValuesFromList returns a random value from Context list l

func (*SharedState) RandomValueFromList

func (st *SharedState) RandomValueFromList(s string) any

func (*SharedState) SetCSV

func (st *SharedState) SetCSV(csv CSVMap)

func (*SharedState) Value

func (st *SharedState) Value(key string) any

type State

type State struct {
	Key    string
	Header map[string]string
}

func NewState

func NewState() *State

func (*State) AddHeader

func (s *State) AddHeader(key string, value string) string

func (*State) SetKey

func (s *State) SetKey(key string) string