storage

Documentation

Index

• Constants
• type ConstModelStorageRegistry
  • func (c ConstModelStorageRegistry) GetStorageRegistry(ctx context.Context) (storage.ProviderRegistry, error)
• type ID
  • func ParseID(id string) (ID, error)
  • func (id ID) String() string
  • func (id ID) Validate() error
• type ModelStorageRegistryGetter
• type Name
  • func ParseName(name string) (Name, error)
  • func (n Name) String() string
  • func (n Name) Validate() error
• type StorageRegistryGetter
• type UUID
  • func NewUUID() (UUID, error)

Constants

const (
	// InvalidStorageName represents an invalid storage name.
	InvalidStorageName = errors.ConstError("invalid storage name")
	// InvalidStorageID represents an invalid storage id.
	InvalidStorageID = errors.ConstError("invalid storage id")
)

const (
	// ErrStorageRegistryDying is used to indicate to *third parties* that the
	// storage registry worker is dying, instead of catacomb.ErrDying, which is
	// unsuitable for propagating inter-worker.
	// This error indicates to consuming workers that their dependency has
	// become unmet and a restart by the dependency engine is imminent.
	ErrStorageRegistryDying = errors.ConstError("storage registry worker is dying")
)

Types

type ConstModelStorageRegistry

type ConstModelStorageRegistry func() storage.ProviderRegistry

ConstModelStorageRegistry is a function that returns the same storage registry every time it is called.

func (ConstModelStorageRegistry) GetStorageRegistry

func (c ConstModelStorageRegistry) GetStorageRegistry(ctx context.Context) (storage.ProviderRegistry, error)

GetStorageRegistry returns a storage registry for the given namespace.

type ID

type ID string

ID represents a storage ID which is a name with a sequence number.

func ParseID

func ParseID(id string) (ID, error)

ParseID returns a new ID. If the id is invalid, an InvalidStorageID error will be returned.

func (ID) String

func (id ID) String() string

String returns the ID as a string.

func (ID) Validate

func (id ID) Validate() error

Validate returns an error if the ID is invalid. The returned error is an InvalidStorageID error.

type ModelStorageRegistryGetter

type ModelStorageRegistryGetter interface {
	// GetStorageRegistry returns a storage registry for the given namespace.
	GetStorageRegistry(context.Context) (storage.ProviderRegistry, error)
}

ModelStorageRegistryGetter is the interface that is used to get a storage registry.

type Name

type Name string

Name represents a storage name.

func ParseName

func ParseName(name string) (Name, error)

ParseName returns a new Name. If the name is invalid, an InvalidStorageName error will be returned.

func (Name) String

func (n Name) String() string

String returns the Name as a string.

func (Name) Validate

func (n Name) Validate() error

Validate returns an error if the Name is invalid. The returned error is an InvalidStorageName error.

type StorageRegistryGetter

type StorageRegistryGetter interface {
	// GetStorageRegistry returns a storage registry for the given namespace.
	GetStorageRegistry(context.Context, string) (storage.ProviderRegistry, error)
}

StorageRegistryGetter is the interface that is used to get a storage registry.

type UUID

type UUID string

UUID represents a storage unique identifier.

func NewUUID

func NewUUID() (UUID, error)

NewUUID is a convenience function for generating a new storage uuid.