spacestorage

Documentation

Index

• Constants
• Variables
• type InMemorySpaceStorage
  • func (i *InMemorySpaceStorage) AclStorage() (liststorage.ListStorage, error)
  • func (i *InMemorySpaceStorage) AllTrees() map[string]treestorage.TreeStorage
  • func (i *InMemorySpaceStorage) Close() error
  • func (i *InMemorySpaceStorage) CopyStorage() *InMemorySpaceStorage
  • func (i *InMemorySpaceStorage) CreateTreeStorage(payload treestorage.TreeStorageCreatePayload) (treestorage.TreeStorage, error)
  • func (i *InMemorySpaceStorage) HasTree(id string) (bool, error)
  • func (i *InMemorySpaceStorage) Id() string
  • func (i *InMemorySpaceStorage) IsSpaceDeleted() (bool, error)
  • func (i *InMemorySpaceStorage) ReadSpaceHash() (hash string, err error)
  • func (i *InMemorySpaceStorage) SetSpaceDeleted() error
  • func (i *InMemorySpaceStorage) SetTreeDeletedStatus(id, state string) error
  • func (i *InMemorySpaceStorage) SetTrees(trees map[string]treestorage.TreeStorage)
  • func (i *InMemorySpaceStorage) SpaceHeader() (*spacesyncproto.RawSpaceHeaderWithId, error)
  • func (i *InMemorySpaceStorage) SpaceSettingsId() string
  • func (i *InMemorySpaceStorage) StoredIds() ([]string, error)
  • func (i *InMemorySpaceStorage) TreeDeletedStatus(id string) (string, error)
  • func (i *InMemorySpaceStorage) TreeRoot(id string) (*treechangeproto.RawTreeChangeWithId, error)
  • func (i *InMemorySpaceStorage) TreeStorage(id string) (treestorage.TreeStorage, error)
  • func (i *InMemorySpaceStorage) WriteSpaceHash(hash string) error
• type InMemorySpaceStorageProvider
  • func (i *InMemorySpaceStorageProvider) CreateSpaceStorage(payload SpaceStorageCreatePayload) (SpaceStorage, error)
  • func (i *InMemorySpaceStorageProvider) Init(a *app.App) (err error)
  • func (i *InMemorySpaceStorageProvider) Name() (name string)
  • func (i *InMemorySpaceStorageProvider) SetStorage(storage SpaceStorage)
  • func (i *InMemorySpaceStorageProvider) SpaceExists(id string) bool
  • func (i *InMemorySpaceStorageProvider) WaitSpaceStorage(ctx context.Context, id string) (SpaceStorage, error)
• type SpaceStorage
  • func NewInMemorySpaceStorage(payload SpaceStorageCreatePayload) (SpaceStorage, error)
• type SpaceStorageCreatePayload
• type SpaceStorageProvider
  • func NewInMemorySpaceStorageProvider() SpaceStorageProvider

Constants

const (
	TreeDeletedStatusQueued  = "queued"
	TreeDeletedStatusDeleted = "deleted"
)

const CName = "common.commonspace.spacestorage"

Variables

var (
	ErrSpaceStorageExists   = errors.New("space storage exists")
	ErrSpaceStorageMissing  = errors.New("space storage missing")
	ErrIncorrectSpaceHeader = errors.New("incorrect space header")

	ErrTreeStorageAlreadyDeleted = errors.New("tree storage already deleted")
)

Types

type InMemorySpaceStorage

type InMemorySpaceStorage struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*InMemorySpaceStorage) AclStorage

func (i *InMemorySpaceStorage) AclStorage() (liststorage.ListStorage, error)

func (*InMemorySpaceStorage) AllTrees

func (i *InMemorySpaceStorage) AllTrees() map[string]treestorage.TreeStorage

func (*InMemorySpaceStorage) Close

func (i *InMemorySpaceStorage) Close() error

func (*InMemorySpaceStorage) CopyStorage

func (i *InMemorySpaceStorage) CopyStorage() *InMemorySpaceStorage

func (*InMemorySpaceStorage) CreateTreeStorage

func (i *InMemorySpaceStorage) CreateTreeStorage(payload treestorage.TreeStorageCreatePayload) (treestorage.TreeStorage, error)

func (*InMemorySpaceStorage) HasTree

func (i *InMemorySpaceStorage) HasTree(id string) (bool, error)

func (*InMemorySpaceStorage) Id

func (i *InMemorySpaceStorage) Id() string

func (*InMemorySpaceStorage) IsSpaceDeleted

func (i *InMemorySpaceStorage) IsSpaceDeleted() (bool, error)

func (*InMemorySpaceStorage) ReadSpaceHash

func (i *InMemorySpaceStorage) ReadSpaceHash() (hash string, err error)

func (*InMemorySpaceStorage) SetSpaceDeleted

func (i *InMemorySpaceStorage) SetSpaceDeleted() error

func (*InMemorySpaceStorage) SetTreeDeletedStatus

func (i *InMemorySpaceStorage) SetTreeDeletedStatus(id, state string) error

func (*InMemorySpaceStorage) SetTrees

func (i *InMemorySpaceStorage) SetTrees(trees map[string]treestorage.TreeStorage)

func (*InMemorySpaceStorage) SpaceHeader

func (i *InMemorySpaceStorage) SpaceHeader() (*spacesyncproto.RawSpaceHeaderWithId, error)

func (*InMemorySpaceStorage) SpaceSettingsId

func (i *InMemorySpaceStorage) SpaceSettingsId() string

func (*InMemorySpaceStorage) StoredIds

func (i *InMemorySpaceStorage) StoredIds() ([]string, error)

func (*InMemorySpaceStorage) TreeDeletedStatus

func (i *InMemorySpaceStorage) TreeDeletedStatus(id string) (string, error)

func (*InMemorySpaceStorage) TreeRoot

func (i *InMemorySpaceStorage) TreeRoot(id string) (*treechangeproto.RawTreeChangeWithId, error)

func (*InMemorySpaceStorage) TreeStorage

func (i *InMemorySpaceStorage) TreeStorage(id string) (treestorage.TreeStorage, error)

func (*InMemorySpaceStorage) WriteSpaceHash

func (i *InMemorySpaceStorage) WriteSpaceHash(hash string) error

type InMemorySpaceStorageProvider

type InMemorySpaceStorageProvider struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*InMemorySpaceStorageProvider) CreateSpaceStorage

func (i *InMemorySpaceStorageProvider) CreateSpaceStorage(payload SpaceStorageCreatePayload) (SpaceStorage, error)

func (*InMemorySpaceStorageProvider) Init

func (i *InMemorySpaceStorageProvider) Init(a *app.App) (err error)

func (*InMemorySpaceStorageProvider) Name

func (i *InMemorySpaceStorageProvider) Name() (name string)

func (*InMemorySpaceStorageProvider) SetStorage

func (i *InMemorySpaceStorageProvider) SetStorage(storage SpaceStorage)

func (*InMemorySpaceStorageProvider) SpaceExists

func (i *InMemorySpaceStorageProvider) SpaceExists(id string) bool

func (*InMemorySpaceStorageProvider) WaitSpaceStorage

func (i *InMemorySpaceStorageProvider) WaitSpaceStorage(ctx context.Context, id string) (SpaceStorage, error)

type SpaceStorage

type SpaceStorage interface {
	Id() string
	SetSpaceDeleted() error
	IsSpaceDeleted() (bool, error)
	SetTreeDeletedStatus(id, state string) error
	TreeDeletedStatus(id string) (string, error)
	SpaceSettingsId() string
	AclStorage() (liststorage.ListStorage, error)
	SpaceHeader() (*spacesyncproto.RawSpaceHeaderWithId, error)
	StoredIds() ([]string, error)
	TreeRoot(id string) (*treechangeproto.RawTreeChangeWithId, error)
	TreeStorage(id string) (treestorage.TreeStorage, error)
	HasTree(id string) (bool, error)
	CreateTreeStorage(payload treestorage.TreeStorageCreatePayload) (treestorage.TreeStorage, error)
	WriteSpaceHash(hash string) error
	ReadSpaceHash() (hash string, err error)

	Close() error
}

TODO: consider moving to some file with all common interfaces etc

func NewInMemorySpaceStorage

func NewInMemorySpaceStorage(payload SpaceStorageCreatePayload) (SpaceStorage, error)

type SpaceStorageCreatePayload

type SpaceStorageCreatePayload struct {
	AclWithId           *aclrecordproto.RawAclRecordWithId
	SpaceHeaderWithId   *spacesyncproto.RawSpaceHeaderWithId
	SpaceSettingsWithId *treechangeproto.RawTreeChangeWithId
}

type SpaceStorageProvider

type SpaceStorageProvider interface {
	app.Component
	WaitSpaceStorage(ctx context.Context, id string) (SpaceStorage, error)
	SpaceExists(id string) bool
	CreateSpaceStorage(payload SpaceStorageCreatePayload) (SpaceStorage, error)
}

func NewInMemorySpaceStorageProvider

func NewInMemorySpaceStorageProvider() SpaceStorageProvider