exporter

type ExportKind string

type Manifest struct {
	ExportFormatVersion int            `json:"export_format_version"`
	ExportKind          ExportKind     `json:"export_kind"`
	ExportedAt          time.Time      `json:"exported_at"`
	ModctlVersion       string         `json:"modctl_version"`
	SchemaVersion       int64          `json:"schema_version"`
	DBSha256            string         `json:"db_sha256"`
	NexusCacheSha256    string         `json:"nexus_cache_sha256"`
	Counts              ManifestCounts `json:"counts"`
	Game                *ManifestGame  `json:"game,omitempty"`
}

type ManifestCounts struct {
	Archives  int `json:"archives"`
	Backups   int `json:"backups"`
	Overrides int `json:"overrides"`
}

type ManifestGame struct {
	StoreID     string `json:"store_id"`
	StoreGameID string `json:"store_game_id"`
	DisplayName string `json:"display_name"`
}

type Options struct {
	// ModctlVersion is injected from rootCmd.Version
	ModctlVersion string
	// SkipInventory omits archive_inventory_entries from game-scoped exports
	SkipInventory bool
	// OutputPath is the destination file
	OutputPath string
	// NoVerify skips rehashing blobs before export
	NoVerify bool
	// CacheDBPath is the full path to the nexus_cache.db
	CacheDBPath string
	// ScratchDir is the directory that the snapshots of the databases are
	// made in, before they are written to the bundle (and removed). It has
	// to be there, and to have room for a copy of the databases. It is not
	// found by the exporter: nothing is made anywhere that it was not told.
	ScratchDir string
	// Schema is the schema of the databases that are in the bundle: the
	// version that the bundle says the database is at is its, and so is what
	// the database of a game is made with. It is not found by the exporter.
	Schema *database.Schema
	// Progress, if set, is told how verifying blobs is going. The exporter
	// itself prints nothing.
	Progress func(Progress)
}

type Progress struct {
	Kind  ProgressKind
	Done  int
	Total int
}

type ProgressKind int

type Result struct {
	// SkippedBlobs are the hashes of blobs that were in the database but
	// missing from disk, and so were left out of the export.
	SkippedBlobs []string
}