storage

Documentation

Overview

Package storage is not expected to be used by the mobile app.

Index

• type Provider
  • func New(mobileBindingProvider api.Provider) *Provider
  • func (p *Provider) Close() error
  • func (p *Provider) GetOpenStores() []spi.Store
  • func (p *Provider) GetStoreConfig(name string) (spi.StoreConfiguration, error)
  • func (p *Provider) OpenStore(name string) (spi.Store, error)
  • func (p *Provider) SetStoreConfig(name string, config spi.StoreConfiguration) error

Types

type Provider

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

Provider represents a storage provider wrapper that allows for conversion between the spi/provider storage interfaces and the mobile-bindings-compatible interface in aries-framework-go/cmd/aries-agent-mobile/pkg/api/storage.go.

func New

func New(mobileBindingProvider api.Provider) *Provider

New returns a new storage provider wrapper.

func (*Provider) Close

func (p *Provider) Close() error

Close closes all stores created under this store provider. For persistent mobile binding store implementations, this does not delete any data in the underlying databases.

func (*Provider) GetOpenStores

func (p *Provider) GetOpenStores() []spi.Store

GetOpenStores returns all currently open stores.

func (*Provider) GetStoreConfig

func (p *Provider) GetStoreConfig(name string) (spi.StoreConfiguration, error)

GetStoreConfig gets the current store configuration. The store must be created prior to calling this method. If the store cannot be found, then an error wrapping ErrStoreNotFound will be returned. If name is blank, then an error will be returned.

func (*Provider) OpenStore

func (p *Provider) OpenStore(name string) (spi.Store, error)

OpenStore opens a store with the given name and returns a handle. If the store has never been opened before, then it is created. Store names are not case-sensitive. If name is blank, then an error will be returned.

func (*Provider) SetStoreConfig

func (p *Provider) SetStoreConfig(name string, config spi.StoreConfiguration) error

SetStoreConfig sets the configuration on a store. The store must be created prior to calling this method. If the store cannot be found, then an error wrapping ErrStoreNotFound will be returned. If name is blank, then an error will be returned.