sync

Documentation

Index

• type Event
• type EventKind
• type Options
• type RunResult
  • func Run(ctx context.Context, cfg *config.Config, opts Options) (*RunResult, error)

Types

type Event

type Event struct {
	Kind   EventKind
	Source string
	Result *source.SyncResult // nil for start events
	Err    error              // non-nil if source failed
}

Event is emitted during sync to report per-source progress.

type EventKind

type EventKind int

EventKind identifies the type of sync progress event.

const (
	EventSourceStart EventKind = iota
	EventSourceDone
	EventManifestError
)

type Options

type Options struct {
	SourceNames []string
	Force       bool
	DryRun      bool
	MaxParallel int
	Clean       bool
	OnEvent     func(Event) // optional; nil = silent
}

type RunResult

type RunResult struct {
	Sources    int
	Downloaded int
	Deleted    int
	Skipped    int
	Errors     int
}

RunResult contains aggregate counts from a completed sync run.

func Run

func Run(ctx context.Context, cfg *config.Config, opts Options) (*RunResult, error)