storage

Documentation

Index

• Variables
• type ConfigStore
• type NarInfoStore
• type NarStore

Variables

var (
	// ErrNotFound is returned if the nar or narinfo were not found.
	ErrNotFound = errors.New("not found")

	// ErrAlreadyExists is returned the store already has a file with the
	// same name.
	ErrAlreadyExists = errors.New("file already exists")
)

Types

type ConfigStore

type ConfigStore interface {
	// GetSecretKey returns secret key from the store.
	//
	// Deprecated: Use config.GetSecretKey instead.
	GetSecretKey(ctx context.Context) (signature.SecretKey, error)

	// PutSecretKey stores the secret key in the store.
	//
	// Deprecated: Use config.SetSecretKey instead.
	PutSecretKey(ctx context.Context, sk signature.SecretKey) error

	// DeleteSecretKey deletes the secret key in the store.
	//
	// Deprecated: The secret key is stored in the database.
	DeleteSecretKey(ctx context.Context) error
}

ConfigStore represents a store for the ncps to use for storing configurations.

Deprecated: The configuration is now stored in the database. This interface will be removed in a future release.

type NarInfoStore

type NarInfoStore interface {
	// HasNarInfo returns true if the store has the narinfo.
	HasNarInfo(ctx context.Context, hash string) bool

	// GetNarInfo returns narinfo from the store.
	GetNarInfo(ctx context.Context, hash string) (*narinfo.NarInfo, error)

	// PutNarInfo puts the narinfo in the store.
	PutNarInfo(ctx context.Context, hash string, narInfo *narinfo.NarInfo) error

	// DeleteNarInfo deletes the narinfo from the store.
	DeleteNarInfo(ctx context.Context, hash string) error

	// WalkNarInfos walks all narinfos in the store and calls fn for each one.
	WalkNarInfos(ctx context.Context, fn func(hash string) error) error
}

NarInfoStore represents a store capable of storing narinfos.

type NarStore

type NarStore interface {
	// HasNar returns true if the store has the nar.
	HasNar(ctx context.Context, narURL nar.URL) bool

	// GetNar returns nar from the store.
	// NOTE: The caller must close the returned io.ReadCloser!
	GetNar(ctx context.Context, narURL nar.URL) (int64, io.ReadCloser, error)

	// PutNar puts the nar in the store.
	PutNar(ctx context.Context, narURL nar.URL, body io.Reader) (int64, error)

	// DeleteNar deletes the nar from the store.
	DeleteNar(ctx context.Context, narURL nar.URL) error

	// WalkNars walks all NAR files in the store and calls fn for each one.
	WalkNars(ctx context.Context, fn func(narURL nar.URL) error) error
}

NarStore represents a store capable of storing nars.