persist

Documentation

Index

• Constants
• type Config
  • func DefaultConfig() Config
• type Persist
  • func New[F comparable, O operation.Operation[F]](kfs kfs.FS[F], config Config) *Persist[F, O]
  • func (p *Persist[K, O]) Flow(ctx signal.Context, opts ...confluence.Option)

Constants

const (
	// DefaultNumWorkers is the default maximum number of goroutines Persist can operate at once.
	DefaultNumWorkers = 10
)

Types

type Config

type Config struct {
	// NumWorkers represents the number of goroutines that will be used to execute operations.
	// This value must be at least 1.
	NumWorkers int
	// Persist will log events to this Logger.
	Logger *zap.Logger
}

func DefaultConfig

func DefaultConfig() Config

type Persist

type Persist[F comparable, O operation.Operation[F]] struct {
	Config
	confluence.UnarySink[[]O]
	// contains filtered or unexported fields
}

Persist wraps a kfs.KFS and provides a mechanism for easily executing operations on it. Persist uses a pool of goroutines to execute operations concurrently. To create a new Persist, use persist.New.

func New

func New[F comparable, O operation.Operation[F]](kfs kfs.FS[F], config Config) *Persist[F, O]

New creates a new Persist that wraps the provided kfs.FS.

func (*Persist[K, O]) Flow

func (p *Persist[K, O]) Flow(ctx signal.Context, opts ...confluence.Option)