Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

mirror

package

Go to main page

Versions in this module

v0

v0.6.0

Jul 27, 2026

v0.5.1

Jun 29, 2026

v0.5.0

Jun 7, 2026

v0.4.0

May 22, 2026

v0.3.2

May 3, 2026

v0.3.1

May 2, 2026

Changes in this version

+ type Job struct

+ CreatedAt time.Time

+ Error string

+ ID string

+ Progress Progress

+ State JobState

+ type JobRequest struct

+ PURLs []string

+ Registry string

+ type JobState string

+ const JobStateCanceled

+ const JobStateComplete

+ const JobStateFailed

+ const JobStatePending

+ const JobStateRunning

+ type JobStore struct

+ func NewJobStore(ctx context.Context, m *Mirror) *JobStore

+ func (js *JobStore) Cancel(id string) bool

+ func (js *JobStore) Cleanup()

+ func (js *JobStore) Create(req JobRequest) (string, error)

+ func (js *JobStore) Get(id string) *Job

+ func (js *JobStore) StartCleanup(ctx context.Context)

+ type Mirror struct

+ func New(proxy *handler.Proxy, db *database.DB, store storage.Storage, ...) *Mirror

+ func (m *Mirror) Run(ctx context.Context, source Source, onProgress ...ProgressFunc) (*Progress, error)

+ func (m *Mirror) RunDryRun(ctx context.Context, source Source) ([]PackageVersion, error)

+ type MirrorError struct

+ Ecosystem string

+ Error string

+ Name string

+ Version string

+ type PURLSource struct

+ PURLs []string

+ RegClient *registries.Client

+ func (s *PURLSource) Enumerate(ctx context.Context, fn func(PackageVersion) error) error

+ type PackageVersion struct

+ Ecosystem string

+ Name string

+ Version string

+ func (pv PackageVersion) String() string

+ type Progress struct

+ Bytes int64

+ Completed int64

+ Errors []MirrorError

+ Failed int64

+ Phase string

+ Skipped int64

+ StartedAt time.Time

+ Total int64

+ type ProgressFunc func(Progress)

+ type RegistrySource struct

+ Ecosystem string

+ func (s *RegistrySource) Enumerate(_ context.Context, _ func(PackageVersion) error) error

+ type SBOMSource struct

+ Path string

+ RegClient *registries.Client

+ func (s *SBOMSource) Enumerate(ctx context.Context, fn func(PackageVersion) error) error

+ type Source interface

+ Enumerate func(ctx context.Context, fn func(PackageVersion) error) error

v0.3.0

Apr 13, 2026