storage

type AnyKey fmt.Stringer

type Format uint8

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

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

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

type Key struct {
	KindKey
	runtime.UID
}

type KindKey struct {
	runtime.Kind
}

type MappedRawStorage interface {
	RawStorage

	// AddMapping binds a Key's virtual path to a physical file path
	AddMapping(key Key, path string)
	// RemoveMapping removes the physical file
	// path mapping matching the given Key
	RemoveMapping(key Key)
}

type RawStorage interface {
	// Read returns a resource's content based on key
	Read(key Key) ([]byte, error)
	// Exists checks if the resource indicated by key exists
	Exists(key Key) bool
	// Write writes the given content to the resource indicated by key
	Write(key Key, content []byte) error
	// Delete deletes the resource indicated by key
	Delete(key Key) error
	// List returns all matching resource Keys based on the given KindKey
	List(key KindKey) ([]Key, error)
	// Checksum returns a string checksum for the resource indicated by key
	Checksum(key Key) (string, error)
	// Format returns the format of the contents of the resource indicated by key
	Format(key Key) Format

	// WatchDir returns the path for Watchers to watch changes in
	WatchDir() string
	// GetKey retrieves the Key containing the virtual path based
	// on the given physical file path returned by a Watcher
	GetKey(path string) (Key, error)
}

type Storage interface {
	// New creates a new Object for the specified kind
	New(gvk schema.GroupVersionKind) (runtime.Object, error)
	// Get returns a new Object for the resource at the specified kind/uid path, based on the file content
	Get(gvk schema.GroupVersionKind, uid runtime.UID) (runtime.Object, error)
	// GetMeta returns a new Object's APIType representation for the resource at the specified kind/uid path
	GetMeta(gvk schema.GroupVersionKind, uid runtime.UID) (runtime.Object, error)
	// Set saves the Object to disk. If the Object does not exist, the
	// ObjectMeta.Created field is set automatically
	Set(gvk schema.GroupVersionKind, obj runtime.Object) error
	// Patch performs a strategic merge patch on the Object with the given UID, using the byte-encoded patch given
	Patch(gvk schema.GroupVersionKind, uid runtime.UID, patch []byte) error
	// Delete removes an Object from the storage
	Delete(gvk schema.GroupVersionKind, uid runtime.UID) error
	// List lists Objects for the specific kind
	List(gvk schema.GroupVersionKind) ([]runtime.Object, error)
	// ListMeta lists all Objects' APIType representation. In other words,
	// only metadata about each Object is unmarshalled (uid/name/kind/apiVersion).
	// This allows for faster runs (no need to unmarshal "the world"), and less
	// resource usage, when only metadata is unmarshalled into memory
	ListMeta(gvk schema.GroupVersionKind) ([]runtime.Object, error)
	// Count returns the amount of available Objects of a specific kind
	// This is used by Caches to check if all Objects are cached to perform a List
	Count(gvk schema.GroupVersionKind) (uint64, error)
	// Checksum returns a string representing the state of an Object on disk
	// The checksum should change if any modifications have been made to the
	// Object on disk, it can be e.g. the Object's modification timestamp or
	// calculated checksum
	Checksum(gvk schema.GroupVersionKind, uid runtime.UID) (string, error)
	// RawStorage returns the RawStorage instance backing this Storage
	RawStorage() RawStorage
	// Serializer returns the serializer
	Serializer() serializer.Serializer
	// Close closes all underlying resources (e.g. goroutines) used; before the application exits
	Close() error
}