instance

type Instance[D state.Initializable[D, *D]] struct {
	// Every instance must have a name - if one is not specified, it defaults to "default" when the Instance is
	// initialized; this is used for the name of the state file on disk as "{Name}.yaml".
	//
	// Example Behavior:
	//
	// With Name "foo":
	//     "foo.yaml"
	// With Name "foo_bar.baz":
	//     "foo_bar.baz.yaml"
	Name string
	// Every instance must have a Kind - if one is not specified, it defaults to "saves" when the Instance is
	// initialized; this is used to determine the folder to save the state file in as "{root folder}/{Kind}/"
	//
	// Example Behavior:
	//
	// With root folder "myApp", Kind.FolderName "saves", and Name "foo":
	//     "myApp/saves/foo.yaml"
	// With root folder "myApp", Kind.FolderName "journals", and Name "2022-01-31":
	//     "myApp/journals/2022-01-31.yaml"
	Kind state.Kind
	// Instances *may* be related to a Persona; if they are, the Persona's name is treated as a namespace for the
	// instance, using "{root folder}/personas/{Persona}/{Category}/" instead of "{root folder}/{Category}/"
	//
	// Example Behavior:
	//
	// With root folder "myApp", Kind.FolderName "saves", and Name "foo":
	//     "myapp/saves/foo.yaml"
	// With root folder "myApp", Kind.FolderName "journals", Persona.Name "foo", Persona.Kind.FolderName "authors",
	// and Name "bar":
	//     "myapp/personas/foo/saves/bar.yaml"
	Persona Persona
	// Instances have a Handle to abstract managing the loading and saving of their state and do not need to be
	// interacted with directly.
	Handle *state.Handle
	// Instances have data of the type you specify when instantiating them. This is what is written to and loaded from
	// the state file. This can be any sort of data you want as long as:
	//
	// 1. It has an Initialize() method that returns a pointer to the data structure itself. You want to make sure that
	// this method sets sensible defaults for the data if you need any - otherwise it can just return a pointer to an
	// empty instance of the data type.
	//
	// 2. It can be marshalled/unmarshalled by viper. In general, you don't need to worry about this unless you're doing
	// something very complex. No such errors or issues have been reported, but viper is what is being used further down
	// the stack to load/save the state file for an instance so if viper can't handle it the instance will error.
	Data D
}

type Persona struct {
	Name string
	Kind state.Kind
}