state

type BaseDirFunc func(state State) string

type Blueprint interface {
	SetBaseDir(baseDir BaseDirFunc) Blueprint
	IsBaseDir(info os.FileInfo) (time.Time, bool)
	SetIsBaseDir(isBD IsBaseDirFunc) Blueprint
	SetString(string StringFunc) Blueprint
	Now() time.Time
	SetNow(now NowFunc) Blueprint
	SetBlueprintFilename(bpFnFunc BlueprintFilenameFunc) Blueprint
	IsBlueprintFilename(filename string) bool
	SetIsBlueprintFilename(isBPFn IsBlueprintFilenameFunc) Blueprint
	// Fields returns the names of all the fields within the Blueprint, except from the field holding the Blueprint
	// itself.
	Fields() []string
	json.Marshaler
	json.Unmarshaler
	CachedField
}

type BlueprintFilenameFunc func(old string) string

type CachedField interface {
	Name() string
	Encoding() EncodingType
	Set(state StateWriter, value any, components ...any) error
	Get(state StateReader, components ...any) (any, error)
	Make() CachedField
}

type CachedFieldIterator interface {
	// Continue checks whether the CachedFieldIterator has not finished. I.e. there are still more elements to iterate over.
	Continue() bool
	// I will return the current i (index) value.
	I() int
	// Components will return the key components for the current element that can be passed to CachedField.Get to
	// retrieve it.
	Components() []any
	// Get will return the current element that is being iterated over.
	Get() (any, error)
	// Next should be called at the end of each loop to retrieve the next element.
	Next() error
	// Field will return the IterableCachedField that this CachedFieldIterator is iterating over.
	Field() IterableCachedField
	// Len returns the length of the CachedFieldIterator.
	Len() int
}

type CachedFieldStringer interface {
	String(state StateReader) string
}

type EncodingType string

type FS interface {
	Exists(name string) bool
}

type FSReadWriter interface {
	FSReader
	FSWriter
}

type FSReader interface {
	FS
	fs.FS
}

type FSWriteCloser interface {
	FSWriter
	io.Closer
}

type FSWriter interface {
	FS
	// WriteFile writes the given data with the given permissions to a file relative to the FSWriter.
	WriteFile(name string, data []byte, perms os.FileMode) error
	// MkdirAll creates all the directories required to
	MkdirAll(path string, perm os.FileMode) error
}

type IsBaseDirFunc func(info os.FileInfo) (time.Time, bool)

type IsBlueprintFilenameFunc func(filename string) bool

type IterableCachedField interface {
	CachedField
	// Iter returns the CachedFieldIterator that can be used to iterate over the instance of the CachedField itself.
	Iter(state StateReader) (CachedFieldIterator, error)
	// Merge will perform a union/update procedure between the referred to IterableCachedField and the given
	// CachedField.
	Merge(mergeTo StateWriter, mergeFrom StateReader, fieldToMerge IterableCachedField) error
}

type NowFunc func() time.Time

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

type State interface {
	// BaseDir returns the directory that the State will Save to.
	//
	// By default, if no override is set within the Blueprint, this is DefaultBaseDir.
	BaseDir() string
	// CreatedAt returns when the State was created.
	//
	// This is the first time that the State was saved to disk. State's that exist only in memory will return a zero
	// time.Time.
	CreatedAt() time.Time
	// Blueprint returns the Blueprint for the State.
	Blueprint() Blueprint
	// Get calls CachedField.Get on the CachedField with the given name.
	Get(fieldName string, components ...any) (any, error)
	// MustGet calls CachedField.Get on the CachedField with the given name, and panics if an error occurs.
	MustGet(fieldName string, components ...any) any
	// Set calls CachedField.Set on the CachedField with the given name.
	Set(fieldName string, value any, components ...any) error
	// MustSet calls CachedField.Set on the CachedField with the given name, and panics if an error occurs.
	MustSet(fieldName string, value any, components ...any)
	// Iter calls IterableCachedField.Iter on the IterableCachedField with the given name.
	Iter(fieldName string) (CachedFieldIterator, error)
	// MustIter calls IterableCachedField.Iter on the IterableCachedField with the given name, and panics if an error
	// occurs.
	MustIter(fieldName string) CachedFieldIterator
	// GetCachedField returns the CachedField of the given name.
	GetCachedField(fieldName string) CachedField
	// GetIterableCachedField returns the IterableCachedField of the given name.
	GetIterableCachedField(fieldName string) IterableCachedField
	// MergeIterableCachedFields merges the IterableCachedField(s) from the given State into the referred to State.
	MergeIterableCachedFields(stateToMerge State) error
	// Delete deletes the on-disk representation of the State. I.e. the directory residing at BaseDir.
	Delete()
	// String returns the string representation of the State.
	//
	// By default, if no override is set within the Blueprint, this is DefaultString.
	String() string
}

type StateReadWriter interface {
	StateReader
	StateWriter
}

type StateReader interface {
	FSReader() FSReader
}

type StateWriter interface {
	FSWriter() FSWriter
}

type StringFunc func(state State) string