store

Documentation

Overview

package store implements types that store message literals.

Messages may be stored either in-memory or on-disk. When stored on disk, they are stored encrypted and optionally compressed.

Index

• func NewCipher(pass []byte) (cipher.AEAD, error)
• type Builder
• type Fallback
• type OnDiskStoreBuilder
  • func (*OnDiskStoreBuilder) Delete(path, userID string) error
  • func (*OnDiskStoreBuilder) New(path, userID string, passphrase []byte) (Store, error)
• type Option
  • func WithFallback(f Fallback) Option
  • func WithSemaphore(sem *Semaphore) Option
• type Semaphore
  • func NewSemaphore(max int, panicHandler async.PanicHandler) *Semaphore
  • func (sem *Semaphore) Block()
  • func (sem *Semaphore) Do(fn func())
  • func (sem *Semaphore) Go(fn func())
  • func (sem *Semaphore) Lock()
  • func (sem *Semaphore) Unblock()
  • func (sem *Semaphore) Unlock()
  • func (sem *Semaphore) Wait()
• type Store
  • func NewOnDiskStore(path string, pass []byte, opt ...Option) (Store, error)
• type WriteControlledStore
  • func NewWriteControlledStore(impl Store) *WriteControlledStore
  • func (w *WriteControlledStore) Close() error
  • func (w *WriteControlledStore) Delete(messageID ...imap.InternalMessageID) error
  • func (w *WriteControlledStore) Get(messageID imap.InternalMessageID) ([]byte, error)
  • func (w *WriteControlledStore) List() ([]imap.InternalMessageID, error)
  • func (w *WriteControlledStore) Set(messageID imap.InternalMessageID, reader io.Reader) error
  • func (w *WriteControlledStore) SetUnchecked(messageID imap.InternalMessageID, reader io.Reader) error
• type WriteControlledStoreBuilder
  • func NewWriteControlledStoreBuilder(builder Builder) *WriteControlledStoreBuilder
  • func (w *WriteControlledStoreBuilder) Delete(dir, userID string) error
  • func (w *WriteControlledStoreBuilder) New(dir, userID string, passphrase []byte) (Store, error)

Functions

func NewCipher

func NewCipher(pass []byte) (cipher.AEAD, error)

Types

type Builder

type Builder interface {
	New(dir, userID string, passphrase []byte) (Store, error)
	Delete(dir, userID string) error
}

type Fallback

type Fallback interface {
	Read(gcm cipher.AEAD, reader io.Reader) ([]byte, error)

	Write(gcm cipher.AEAD, filepath string, data []byte) error
}

Fallback provides an interface to supply an alternative way to read a store file should the main route fail. This is mainly intended to allow users of the library to read old store formats they may have kept on disk. This is a stop-gap until a complete data migration cycle can be implemented in gluon.

type OnDiskStoreBuilder

type OnDiskStoreBuilder struct{}

func (*OnDiskStoreBuilder) Delete

func (*OnDiskStoreBuilder) Delete(path, userID string) error

func (*OnDiskStoreBuilder) New

func (*OnDiskStoreBuilder) New(path, userID string, passphrase []byte) (Store, error)

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithFallback

func WithFallback(f Fallback) Option

func WithSemaphore

func WithSemaphore(sem *Semaphore) Option

type Semaphore

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

Semaphore implements a type used to limit concurrent operations.

func NewSemaphore

func NewSemaphore(max int, panicHandler async.PanicHandler) *Semaphore

NewSemaphore constructs a new semaphore with the given limit.

func (*Semaphore) Block

func (sem *Semaphore) Block()

Block prevents the semaphore from being locked.

func (*Semaphore) Do

func (sem *Semaphore) Do(fn func())

Do executes the given function synchronously.

func (*Semaphore) Go

func (sem *Semaphore) Go(fn func())

Go executes the given function asynchronously.

func (*Semaphore) Lock

func (sem *Semaphore) Lock()

Lock locks the semaphore, waiting first until it is possible.

func (*Semaphore) Unblock

func (sem *Semaphore) Unblock()

Unblock allows the semaphore to be locked again.

func (*Semaphore) Unlock

func (sem *Semaphore) Unlock()

Unlock unlocks the semaphore.

func (*Semaphore) Wait

func (sem *Semaphore) Wait()

Wait waits for all functions started by Go to finish executing.

type Store

type Store interface {
	Get(messageID imap.InternalMessageID) ([]byte, error)
	Set(messageID imap.InternalMessageID, reader io.Reader) error
	Delete(messageID ...imap.InternalMessageID) error
	Close() error
	List() ([]imap.InternalMessageID, error)
}

func NewOnDiskStore

func NewOnDiskStore(path string, pass []byte, opt ...Option) (Store, error)

type WriteControlledStore

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

WriteControlledStore ensures that a given file on disk can safely be accessed by multiple readers and only one writer. Internally we maintain a list of RWLocks per message ID.

func NewWriteControlledStore

func NewWriteControlledStore(impl Store) *WriteControlledStore

func (*WriteControlledStore) Close

func (w *WriteControlledStore) Close() error

func (*WriteControlledStore) Delete

func (w *WriteControlledStore) Delete(messageID ...imap.InternalMessageID) error

func (*WriteControlledStore) Get

func (w *WriteControlledStore) Get(messageID imap.InternalMessageID) ([]byte, error)

func (*WriteControlledStore) List

func (w *WriteControlledStore) List() ([]imap.InternalMessageID, error)

func (*WriteControlledStore) Set

func (w *WriteControlledStore) Set(messageID imap.InternalMessageID, reader io.Reader) error

func (*WriteControlledStore) SetUnchecked

func (w *WriteControlledStore) SetUnchecked(messageID imap.InternalMessageID, reader io.Reader) error

SetUnchecked allows the user to bypass lock access. This will only work if you can guarantee that the data being set does not previously exit (e.g: New message).

type WriteControlledStoreBuilder

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

func NewWriteControlledStoreBuilder

func NewWriteControlledStoreBuilder(builder Builder) *WriteControlledStoreBuilder

func (*WriteControlledStoreBuilder) Delete

func (w *WriteControlledStoreBuilder) Delete(dir, userID string) error

func (*WriteControlledStoreBuilder) New

func (w *WriteControlledStoreBuilder) New(dir, userID string, passphrase []byte) (Store, error)