workspace

type CatOptions struct {
	RevisionId      lib.RevisionId
	SnapshotMonitor lib.RevisionSnapshotMonitor
	// Path is relative to PathPrefix.
	Path       lib.Path
	PathPrefix lib.Path
}

type CommitFilesDest struct {
	Repository *lib.Repository
	// The revision `Files` were computed against, and the parent of the new one.
	// Blocks `Snapshot` already holds are reused instead of read and uploaded again.
	RevisionId lib.RevisionId
	Snapshot   *lib.TempCache[*lib.RevisionEntry]
}

type CommitFilesOptions struct {
	Author  string
	Message string
	Monitor CommitMonitor
	// Which metadata differences count as a change. An entry that differs in no
	// other way is left out of the revision.
	RestorableMetadataFlag lib.RestorableMetadataFlag
}

type CommitFilesSrc struct {
	// `Files` are read from `Src`. `SrcPrefix` is the repository path the root of
	// `Src` maps to, so `<SrcPrefix>/a/b.txt` is read from `a/b.txt`.
	Src       lib.FS
	SrcPrefix lib.Path
	Files     *lib.Temp[*lib.RevisionEntry]
}

type CommitMonitor interface {
	OnStart(entry *lib.RevisionEntry) error
	// bytesWritten: if nil, the block already existed; otherwise, the total block size (including
	// header) written.
	OnAddBlock(entry *lib.RevisionEntry, blockId lib.BlockId, dataSize int, bytesWritten *int) error
	OnEnd(entry *lib.RevisionEntry) error
	OnBeforeCommit() error
}

type CpMonitor interface {
	OnStart(entry *lib.RevisionEntry, targetPath string) error
	OnExists(entry *lib.RevisionEntry, targetPath string) CpOnExists
	OnWrite(entry *lib.RevisionEntry, targetPath string, blockId lib.BlockId, data []byte) error
	OnEnd(entry *lib.RevisionEntry, targetPath string) error
	OnError(entry *lib.RevisionEntry, targetPath string, err error) CpOnError
}

type CpOnError int

type CpOnExists int

type CpOptions struct {
	RevisionId             lib.RevisionId
	Monitor                CpMonitor
	SnapshotMonitor        lib.RevisionSnapshotMonitor
	Include                *lib.PathInclusionFilter
	Exclude                *lib.PathExclusionFilter
	PathPrefix             lib.Path
	RestorableMetadataFlag lib.RestorableMetadataFlag
}

type DefaultCommitMonitor struct {
	StartTime            time.Time
	Paths                int
	RawBytesAdded        int64
	CompressedBytesAdded int64
	RawBytesReused       int64
	// contains filtered or unexported fields
}

type DefaultCpMonitor struct {
	StartTime    time.Time
	Paths        int
	Excluded     int
	BytesWritten int64
	Errors       int
	// contains filtered or unexported fields
}

type DefaultHealthCheckMonitor struct {
	StartTime      time.Time
	EndTime        time.Time
	Revisions      int
	Paths          int
	Blocks         int
	BlockBytes     int64
	OrphanedBlocks []lib.BlockId
	// contains filtered or unexported fields
}

type DefaultMonitorMode int

type DefaultRevisionSnapshotMonitor struct {
	Revisions int
	Entries   int
	// contains filtered or unexported fields
}

type DefaultStagingMonitor struct {
	StartTime      time.Time
	Paths          int
	Excluded       int
	TotalFileSizes int64
	// contains filtered or unexported fields
}

type DefaultSyncRepoMonitor struct {
	TargetName string
	StartTime  time.Time
	SrcBlocks  int
	DstBlocks  int
	Blocks     int
	Bytes      int64
	// contains filtered or unexported fields
}

type ForceCommitOptions struct {
	MergeOptions
}

type Import struct {
	Changes StatusFiles
	// contains filtered or unexported fields
}

type ImportOptions struct {
	// The subtree `Dest` is relative to, and the space `Changes` is reported in.
	PathPrefix lib.Path
	// The directory below `PathPrefix` that receives the contents of the source.
	Dest                   lib.Path
	Include                *lib.PathInclusionFilter
	Exclude                *lib.PathExclusionFilter
	StagingMonitor         StagingEntryMonitor
	CommitMonitor          CommitMonitor
	SnapshotMonitor        lib.RevisionSnapshotMonitor
	RestorableMetadataFlag lib.RestorableMetadataFlag
}

type LogOptions struct {
	// Include and Exclude match paths relative to PathPrefix. Either one drops
	// a revision that has no path left after filtering.
	Include *lib.PathInclusionFilter
	Exclude *lib.PathExclusionFilter
	Status  bool
	// Range is not validated against the repository:
	// a Range.Until not in the repository fails when its revision is read,
	// and a Range.Since not in the repository is never reached, so the log
	// runs to the root.
	Range lib.RevisionRange
	// PathPrefix scopes the reported paths to a subtree. It deliberately does
	// not hide revisions that touched nothing inside it, because history is
	// global: revision ids, `~<n>`, and ranges all address the whole chain.
	PathPrefix lib.Path
}

type LsFile struct {
	Path     lib.Path
	Metadata lib.PathMetadata
}

type LsFormat struct {
	FullPath bool
	FullMode bool
	FileHash bool
	// A `time.Format` string or one of the special values "relative", "unix", or "unix-fraction".
	TimestampFormat   string
	HumanReadableSize bool
}

type LsOptions struct {
	RevisionId      lib.RevisionId
	SnapshotMonitor lib.RevisionSnapshotMonitor
	Include         *lib.PathInclusionFilter
	Exclude         *lib.PathExclusionFilter
	PathPrefix      lib.Path
	// Maximum number of path segments to list, counted from `PathPrefix`.
	// 0 means unlimited.
	Depth int
}

type MergeConflict struct {
	WorkspaceEntry  *lib.RevisionEntry
	RepositoryEntry *lib.RevisionEntry
}

type MergeConflictsError []MergeConflict

type MergeOptions struct {
	StagingMonitor         StagingEntryMonitor
	CpMonitor              CpMonitor
	CommitMonitor          CommitMonitor
	SnapshotMonitor        lib.RevisionSnapshotMonitor
	Author                 string
	Message                string
	RestorableMetadataFlag lib.RestorableMetadataFlag
	UseStagingCache        bool
}

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

type MonitorEmit func(text string)

type RemoteRepository string

type ResetError struct {
	LocalChanges *lib.TempCache[*lib.RevisionEntry]
}

type ResetOptions struct {
	RevisionId             lib.RevisionId
	Force                  bool
	StagingMonitor         StagingEntryMonitor
	CpMonitor              CpMonitor
	SnapshotMonitor        lib.RevisionSnapshotMonitor
	RestorableMetadataFlag lib.RestorableMetadataFlag
	UseStagingCache        bool
}

type RevisionLog struct {
	RevisionId lib.RevisionId
	Revision   lib.Revision
	Files      []StatusFile
	// TotalFiles is how many paths the revision holds, including the ones
	// skipped by PathPrefix, Include, and Exclude.
	TotalFiles int
}

type RunSyncOpts struct {
	Monitor       lib.RepositorySyncMonitor
	Workers       int
	SkipHeadCheck bool
}

type Staging struct {
	Include *lib.PathInclusionFilter
	Exclude *lib.PathExclusionFilter
	// contains filtered or unexported fields
}

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

type StagingEntry struct {
	RepoPath lib.Path
	Metadata lib.PathMetadata
	Ctime    lib.Timestamp
	Size     int64
	Inode    uint64
}

type StagingEntryChunk struct {
	Entries []*StagingEntry
}

type StagingEntryMonitor interface {
	OnStart(path lib.Path, dirEntry fs.DirEntry) error
	OnEnd(path lib.Path, excluded bool, metadata *lib.PathMetadata) error
}

type StatusFile struct {
	Path     lib.Path
	Kind     lib.RevisionEntryKind
	Metadata lib.PathMetadata
}

type StatusFiles []StatusFile

type StatusOptions struct {
	Include                *lib.PathInclusionFilter
	Exclude                *lib.PathExclusionFilter
	Monitor                StagingEntryMonitor
	SnapshotMonitor        lib.RevisionSnapshotMonitor
	RestorableMetadataFlag lib.RestorableMetadataFlag
	UseStagingCache        bool
}

type SyncTarget struct {
	Name string
	URI  string
}

type TestCommitMonitor struct {
	OnStartCalls    []*lib.RevisionEntry
	OnAddBlockCalls []*lib.RevisionEntry
	OnEndCalls      []*lib.RevisionEntry
}

type TestCpMonitor struct {
	Exists        CpOnExists
	OnStartCalls  []*lib.RevisionEntry
	OnWriteCalls  []*lib.RevisionEntry
	OnExistsCalls []*lib.RevisionEntry
	OnEndCalls    []*lib.RevisionEntry
	OnErrorCalls  []*lib.RevisionEntry
}

type TestStagingEntryInfo struct {
	Path string
	Mode fs.FileMode
	Hash lib.Sha256
}

type TestStagingMonitor struct{}

type TestWorkspace struct {
	*Workspace
	*lib.TestFS
	// contains filtered or unexported fields
}

type Workspace struct {
	RemoteRepository RemoteRepository
	PathPrefix       lib.Path
	Storage          lib.Storage
	FS               lib.FS
	TempFS           lib.FS
}

type WorkspaceTestData struct{}