lib

package

Go to main page

Versions in this module

v0

v0.0.5

Aug 23, 2026

Changes in this version

type PathMetadata

+ func (p *PathMetadata) SymLink() (Path, bool)

+ type RepositoryView struct

+ Repository *Repository

+ func NewRepositoryView(repository *Repository, prefix Path) *RepositoryView

+ func (v *RepositoryView) NewCommit(ctx context.Context, tmpFS FS, base *ViewSnapshot) (*ViewCommit, error)

+ func (v *RepositoryView) NewRevisionReader(revision *Revision) *ViewRevisionReader

+ func (v *RepositoryView) NewSnapshot(ctx context.Context, revisionId RevisionId, tmpFS FS, ...) (*ViewSnapshot, error)

+ func (v *RepositoryView) Sub(path Path) *RepositoryView

type TestRepository — darwin/amd64, linux/amd64, windows/amd64

+ func (r *TestRepository) View(prefix string) *RepositoryView

+ type ViewCommit struct

+ func (c *ViewCommit) Add(entry *RevisionEntry) error

+ func (c *ViewCommit) Commit(ctx context.Context, info *CommitInfo) (RevisionId, error)

+ type ViewRevisionReader struct

+ func (r *ViewRevisionReader) Hidden() int

+ func (r *ViewRevisionReader) Read(ctx context.Context, buf BlockBuf) (*RevisionEntry, error)

+ type ViewSnapshot struct

+ RevisionId RevisionId

+ func (s *ViewSnapshot) Cache() (*RevisionEntryCache, error)

+ func (s *ViewSnapshot) Remove() error

v0.0.4

Aug 18, 2026

Changes in this version

+ func ComparePathKey(a, b PathKey) int

+ func PathCompare(a Path, aIsDir bool, b Path, bIsDir bool) int

+ func RewriteRevisions(ctx context.Context, repository *Repository, tempFS FS, ...) error

type Assert

+ func (a Assert) AllFieldsSet(v any, msg ...any)

+ func (a Assert) Fields(expected []string, typ reflect.Type, msg ...any)

+ type DisplayOrderReader struct

+ func NewDisplayOrderReader(source func(BlockBuf) (*RevisionEntry, error)) *DisplayOrderReader

+ func (dr *DisplayOrderReader) Read(buf BlockBuf) (*RevisionEntry, error)

+ type Heap struct

+ func NewHeap[T any](compare func(a, b T) int, capacity int) *Heap[T]

+ func (h *Heap[T]) Len() int

+ func (h *Heap[T]) Peek() T

+ func (h *Heap[T]) Pop() T

+ func (h *Heap[T]) Push(v T)

type Path

+ func NewPathUnchecked(path string) Path

+ type PathKey struct

+ IsDir bool

+ Path Path

type RevisionEntry

+ func (e *RevisionEntry) PathCompare(other *RevisionEntry) int

+ func (e *RevisionEntry) PathDesc() string

+ func (e *RevisionEntry) PathKey() PathKey

+ type RevisionEntryCache = TempCache[*RevisionEntry, PathKey]

type TempWriter

+ func (tw *TempWriter[T]) CloseAndSort() (*Temp[T], error)

+ func (tw *TempWriter[T]) CloseWithoutSort() (*Temp[T], error)

type TestRepository — darwin/amd64, linux/amd64, windows/amd64

+ func (r *TestRepository) AddRevision(parent RevisionId, blocks ...[]*RevisionEntry) RevisionId

v0.0.3

Aug 3, 2026

Changes in this version

+ const BlockIdSize

+ const DefaultTempChunkSize

+ const EncryptedKeySize

+ const EncryptionVersion

+ const MaxBlockDataSize

+ const MaxBlockSize

+ const MaxControlFileSize

+ const MaxPathLen

+ const PathDelim

+ const PathSeparator

+ const RawKeySize

+ const RevisionMagic

+ const SaltSize

+ const StorageVersion

+ const TotalCipherOverhead

+ const UpdateHeadRevisionLockName

+ var ErrBlockNotFound = Errorf("block not found")

+ var ErrCancel = Errorf("operation cancelled")

+ var ErrControlFileNotFound = Errorf("control file not found")

+ var ErrDuplicateTempEntry = Errorf("duplicate entry")

+ var ErrEmptyCommit = Errorf("empty commit")

+ var ErrHeadChanged = Errorf("head changed during commit")

+ var ErrIsSymlink = errors.New("path is a symlink")

+ var ErrLockAlreadyAcquired = errors.New("lock already acquired") — darwin/amd64, linux/amd64, windows/amd64

+ var ErrLockNotFound = Errorf("lock not found")

+ var ErrRootRevision = errors.New("root revision cannot be read")

+ var ErrStorageAlreadyExists = Errorf("storage already exists")

+ var ErrStorageNotFound = Errorf("storage not found")

+ var RepositoryConfigHeaderComment = strings.Trim(..., "\n ")

+ func AtomicWriteFile(fs FS, name string, perm fs.FileMode, data ...[]byte) error

+ func AtomicWriteTempFilename(name string) string

+ func BlockIdCompare(a, b BlockId) int

+ func CheckHealth(ctx context.Context, repository *Repository, tempFS FS, ...) error

+ func CheckPassphraseStrength(phrase []byte) error

+ func Compress(data []byte, target []byte) (n int, ok bool, err error)

+ func Decompress(data []byte) ([]byte, error)

+ func Decrypt(ciphertext []byte, cipher cryptoCipher.AEAD, associatedData []byte, dst []byte) ([]byte, error)

+ func DecryptInPlace(ciphertext []byte, cipher cryptoCipher.AEAD, associatedData []byte) ([]byte, error)

+ func Encrypt(plaintext []byte, cipher cryptoCipher.AEAD, associatedData []byte, dst []byte) ([]byte, error)

+ func EnhanceMetadata(md *PathMetadata, fileInfo fs.FileInfo)

+ func FormatRecoveryCode(data []byte) string

+ func GlobMatch(pattern GlobPattern, text []byte, isDir bool) bool

+ func IsAlnum(c byte) bool

+ func IsAlpha(c byte) bool

+ func IsAtomicWriteTempFile(name string) bool

+ func IsBlank(c byte) bool

+ func IsCntrl(c byte) bool

+ func IsCompressible(data []byte) bool

+ func IsDigit(c byte) bool

+ func IsGraph(c byte) bool

+ func IsLower(c byte) bool

+ func IsPrint(c byte) bool

+ func IsPunct(c byte) bool

+ func IsSpace(c byte) bool

+ func IsUpper(c byte) bool

+ func IsXDigit(c byte) bool

+ func NewCipher(key RawKey) (cryptoCipher.AEAD, error)

+ func Padme(l uint64) uint64

+ func ParseRecoveryCode(s string) ([]byte, error)

+ func PathCompareString(path Path, isDir bool) string

+ func Rand(n int) ([]byte, error)

+ func RandStr(n int) (string, error)

+ func ReadFile(fs FS, name string) ([]byte, error)

+ func RevisionEntryPathCompare(a, b *RevisionEntry) int

+ func RevisionEntryPathCompareString(e *RevisionEntry) string

+ func RevisionEntryPathFilter(pathFilter PathFilter) func(e *RevisionEntry) bool

+ func Stringify(v any) string

+ func SyncRepository(ctx context.Context, src, dst Storage, tempFS FS, ...) error

+ func TagLen(field, wireType int) int

+ func ValidateControlFileName(name string) error

+ func ValidateStorageLockName(name string) error

+ func VarintLen(v int64) int

+ func WalkDirIgnore(fs FS, dir string, f iofs.WalkDirFunc) error

+ func WriteFile(fs FS, name string, data []byte) error

+ func WriteRef(ctx context.Context, storage Storage, name string, revisionId RevisionId) error

+ func WriteToml(dst io.Writer, headerComment string, toml Toml) error

+ type Argon2id struct

+ Memory uint32

+ Parallelism uint8

+ Salt Salt

+ Time uint32

+ func NewArgon2id(salt Salt, params Argon2idParams) Argon2id

+ func UnmarshalArgon2idConfig(s string) (Argon2id, error)

+ func (a Argon2id) Marshal() string

+ type Argon2idParams struct

+ Memory uint32

+ Parallelism uint8

+ Time uint32

+ func DefaultArgon2idParams() Argon2idParams

+ func NewArgon2idParams(time uint32, memory uint32, parallelism uint8) (Argon2idParams, error)

+ func ParseArgon2idParams(s string) (Argon2idParams, error)

+ func (p Argon2idParams) Marshal() string

+ type Assert struct

+ Any any

+ func NewAssert(tb testing.TB) Assert

+ func (a Assert) Call(expected MockCall, calls []MockCall, msg ...any)

+ func (a Assert) Calls(expected []MockCall, calls []MockCall, msg ...any)

+ func (a Assert) Contains(haystack any, needle any, msg ...any)

+ func (a Assert) Equal(expected, actual any, msg ...any)

+ func (a Assert) Error(err error, contains string, msg ...any)

+ func (a Assert) ErrorIs(err, target error, msg ...any)

+ func (a Assert) Greater(x, y any, msg ...any)

+ func (a Assert) Less(x, y any, msg ...any)

+ func (a Assert) Nil(v any, msg ...any)

+ func (a Assert) NoError(err error, msg ...any)

+ func (a Assert) NotEqual(expected, actual any, msg ...any)

+ func (a Assert) NotNil(v any, msg ...any)

+ type Block struct

+ EncryptedData []byte

+ EncryptedHeader []byte

+ func UnmarshallBlock(r *ProtobufReader) (*Block, error)

+ func (o *Block) Marshall(w ProtobufWriter) error

+ func (o *Block) MarshallSize() int

+ func (o *Block) Validate() error

+ type BlockBuf struct

+ func NewBlockBuf() BlockBuf

+ func (b BlockBuf) Bytes() []byte

+ func (b BlockBuf) Read(src io.Reader) ([]byte, error)

+ type BlockHeader struct

+ Compression Compression

+ Dek RawKey

+ EncryptedDataSize uint32

+ Version uint32

+ func UnmarshallBlockHeader(r *ProtobufReader) (*BlockHeader, error)

+ func (o *BlockHeader) Marshall(w ProtobufWriter) error

+ func (o *BlockHeader) MarshallSize() int

+ func (o *BlockHeader) Validate() error

+ type BlockId Sha256Hmac

+ func NewBlockIdFromString(s string) (BlockId, error)

+ func (id BlockId) String() string

+ type Commit struct

+ BaseRevision RevisionId

+ func NewCommit(ctx context.Context, repository *Repository, tmpFS FS) (*Commit, error)

+ func (c *Commit) Add(entry *RevisionEntry) error

+ func (c *Commit) Commit(ctx context.Context, info *CommitInfo) (RevisionId, error)

+ func (c *Commit) EnsureDirExists(path Path, snapshotCache *TempCache[*RevisionEntry], ...) error

+ type CommitInfo struct

+ Author string

+ Message string

+ type Compression uint32

+ const CompressionDeflate

+ const CompressionNone

+ type ControlFileSection string

+ const ControlFileSectionConf

+ const ControlFileSectionRefs

+ const ControlFileSectionSecurity

+ type EncryptedKey [EncryptedKeySize]byte

+ type EnhancedStat_t struct

+ CTimeNSec int32

+ CTimeSec int64

+ Inode uint64

+ func EnhancedStat(fileInfo fs.FileInfo) (*EnhancedStat_t, error)

+ type ExtendedGlobPattern struct

+ BaseDir string

+ IsNegate bool

+ func NewExtendedGlobPattern(pattern string, baseDir string) ExtendedGlobPattern

+ type ExtendedGlobPatterns []ExtendedGlobPattern

+ func CollectIgnorePatterns(fs FS, dir string) (ExtendedGlobPatterns, error)

+ func ParseGlobIgnoreFile(dir string, patterns []string) ExtendedGlobPatterns

+ func (i ExtendedGlobPatterns) Match(path string, isDir bool) bool

+ type FS interface

+ Chmod func(name string, mode fs.FileMode) error

+ Chmtime func(name string, mtime time.Time) error

+ Chown func(name string, uid int, gid int) error

+ FSync func(file io.WriteCloser) error

+ FSyncDir func(path string) error

+ Lock func(ctx context.Context, path string) (unlock func() error, err error)

+ MkSub func(path string) (FS, error)

+ Mkdir func(name string) error

+ MkdirAll func(path string) error

+ OpenRead func(name string) (io.ReadCloser, error)

+ OpenWrite func(name string) (io.WriteCloser, error)

+ OpenWriteExcl func(name string) (io.WriteCloser, error)

+ ReadDir func(name string) ([]fs.DirEntry, error)

+ ReadLink func(name string) (string, error)

+ Remove func(name string) error

+ RemoveAll func(path string) error

+ Rename func(oldpath, newpath string) error

+ Stat func(name string) (fs.FileInfo, error)

+ String func() string

+ Sub func(path string) (FS, error)

+ Symlink func(target string, name string) error

+ WalkDir func(path string, fn fs.WalkDirFunc) error

+ type FileLock struct — darwin/amd64, linux/amd64, windows/amd64

+ func NewLock(path string) *FileLock

+ func (l *FileLock) Lock(ctx context.Context) error

+ func (l *FileLock) TryLock() (bool, error)

+ func (l *FileLock) Unlock() error

+ type FileMode uint32

+ const FileModeDir

+ const FileModeGroupExec

+ const FileModeGroupRead

+ const FileModeGroupWrite

+ const FileModeOtherExec

+ const FileModeOtherRead

+ const FileModeOtherWrite

+ const FileModeOwnerExec

+ const FileModeOwnerRead

+ const FileModeOwnerWrite

+ const FileModePerm

+ const FileModeSetGid

+ const FileModeSetUid

+ const FileModeSticky

+ const FileModeSymlink

+ const FileModeType

+ func NewFileMode(fm fs.FileMode) FileMode

+ func (m FileMode) AsFsFileMode() fs.FileMode

+ func (m FileMode) IsDir() bool

+ func (m FileMode) IsRegular() bool

+ func (m FileMode) IsSetGID() bool

+ func (m FileMode) IsSetUID() bool

+ func (m FileMode) IsSticky() bool

+ func (m FileMode) IsSymlink() bool

+ func (m FileMode) Perm() FileMode

+ func (m FileMode) ShortString() string

+ func (m FileMode) String() string

+ type FileStorage struct

+ FS FS

+ Purpose StoragePurpose

+ func NewFileStorage(fs FS, purpose StoragePurpose) (*FileStorage, error)

+ func (s *FileStorage) DeleteControlFile(_ context.Context, section ControlFileSection, name string) error

+ func (s *FileStorage) ForceUnlock(_ context.Context, name string) error

+ func (s *FileStorage) HasBlock(_ context.Context, blockId BlockId) (bool, error)

+ func (s *FileStorage) HasControlFile(_ context.Context, section ControlFileSection, name string) (bool, error)

+ func (s *FileStorage) Init(_ context.Context, config Toml, headerComment string) error

+ func (s *FileStorage) Lock(ctx context.Context, name string) (func() error, error)

+ func (s *FileStorage) Open(_ context.Context) (Toml, error)

+ func (s *FileStorage) ReadBlock(_ context.Context, blockId BlockId, buf BlockBuf) ([]byte, error)

+ func (s *FileStorage) ReadBlockIds(ctx context.Context, yield func(BlockId) bool) error

+ func (s *FileStorage) ReadControlFile(_ context.Context, section ControlFileSection, name string) ([]byte, error)

+ func (s *FileStorage) WriteBlock(_ context.Context, blockId BlockId, data []byte) (bool, error)

+ func (s *FileStorage) WriteControlFile(_ context.Context, section ControlFileSection, name string, data []byte) error

+ type GearCDC struct

+ func NewGearCDC(r io.Reader, mask uint64, minSize, maxSize int, table GearCDCTable) *GearCDC

+ func NewGearCDCWithDefaults(r io.Reader, table GearCDCTable) *GearCDC

+ func (g *GearCDC) Read() ([]byte, error)

+ type GearCDCTable [256]uint64

+ func NewGearCDCTable(key RawKey) (GearCDCTable, error)

+ type GlobPattern []byte

+ func PrepareGlobPattern(pattern string) GlobPattern

+ type HealthCheckMonitor interface

+ OnBlockVerified func(blockId BlockId, length int)

+ OnOrphanedBlock func(blockId BlockId)

+ OnRevisionEntry func(entry *RevisionEntry)

+ OnRevisionStart func(revisionId RevisionId)

+ type HealthCheckOptions struct

+ CheckBlocks bool

+ CheckOrphanedBlocks bool

+ Monitor HealthCheckMonitor

+ type LockExistsError struct

+ CreatedAt time.Time

+ Host string

+ Name string

+ Owner string

+ Pid int

+ func (e *LockExistsError) Error() string

+ type Marshallable interface

+ Marshall func(ProtobufWriter) error

+ MarshallSize func() int

+ type MemoryFS struct

+ func NewMemoryFS(maxMemory int64) *MemoryFS

+ func (f *MemoryFS) Chmod(name string, mode fs.FileMode) error

+ func (f *MemoryFS) Chmtime(name string, mtime time.Time) error

+ func (f *MemoryFS) Chown(name string, uid int, gid int) error

+ func (f *MemoryFS) FSync(file io.WriteCloser) error

+ func (f *MemoryFS) FSyncDir(path string) error

+ func (f *MemoryFS) Lock(ctx context.Context, path string) (func() error, error)

+ func (f *MemoryFS) MkSub(path string) (FS, error)

+ func (f *MemoryFS) Mkdir(name string) error

+ func (f *MemoryFS) MkdirAll(path string) error

+ func (f *MemoryFS) OpenRead(name string) (io.ReadCloser, error)

+ func (f *MemoryFS) OpenWrite(name string) (io.WriteCloser, error)

+ func (f *MemoryFS) OpenWriteExcl(name string) (io.WriteCloser, error)

+ func (f *MemoryFS) ReadDir(name string) ([]fs.DirEntry, error)

+ func (f *MemoryFS) ReadLink(name string) (string, error)

+ func (f *MemoryFS) Remove(name string) error

+ func (f *MemoryFS) RemoveAll(path string) error

+ func (f *MemoryFS) Rename(oldpath, newpath string) error

+ func (f *MemoryFS) Stat(name string) (fs.FileInfo, error)

+ func (f *MemoryFS) String() string

+ func (f *MemoryFS) Sub(path string) (FS, error)

+ func (f *MemoryFS) Symlink(target string, name string) error

+ func (f *MemoryFS) WalkDir(path string, fn fs.WalkDirFunc) error

+ type MockCall struct

+ Args []any

+ Name string

+ func NewMockCall(name string, args ...any) MockCall

+ func (m MockCall) Equal(other MockCall) bool

+ func (m MockCall) String() string

+ type Path struct

+ func NewPath(path string) (Path, error)

+ func (p Path) Base() Path

+ func (p Path) Depth() int

+ func (p Path) Dir() Path

+ func (p Path) IsEmpty() bool

+ func (p Path) IsRelativeTo(base Path) bool

+ func (p Path) Join(other Path) Path

+ func (p Path) Len() int

+ func (p Path) String() string

+ func (p Path) TrimBase(base Path) (Path, bool)

+ type PathExclusionFilter struct

+ Excludes ExtendedGlobPatterns

+ func NewPathExclusionFilter(excludes []string) *PathExclusionFilter

+ func (pef *PathExclusionFilter) Include(p Path, isDir bool) bool

+ type PathFilter interface

+ Include func(p Path, isDir bool) bool

+ type PathInclusionFilter struct

+ Includes ExtendedGlobPatterns

+ func NewPathInclusionFilter(includes []string) *PathInclusionFilter

+ func (pif *PathInclusionFilter) Include(p Path, isDir bool) bool

+ type PathMetadata struct

+ Birthtime *Timestamp

+ BlockIds []BlockId

+ FileHash Sha256

+ FileMode FileMode

+ Gid *uint32

+ Mtime Timestamp

+ Size int64

+ SymLinkTarget *Path

+ Uid *uint32

+ func NewEmptyDirPathMetadata(mtime time.Time) PathMetadata

+ func NewPathMetadataFromFileInfo(fileInfo fs.FileInfo, fileHash Sha256, blockIds []BlockId) PathMetadata

+ func UnmarshallPathMetadata(r *ProtobufReader) (*PathMetadata, error)

+ func (o *PathMetadata) Marshall(w ProtobufWriter) error

+ func (o *PathMetadata) MarshallSize() int

+ func (o *PathMetadata) Validate() error

+ func (p *PathMetadata) HasBirthtime() bool

+ func (p *PathMetadata) HasGID() bool

+ func (p *PathMetadata) HasSymLinkTarget() bool

+ func (p *PathMetadata) HasUID() bool

+ func (p *PathMetadata) IsEqualRestorableAttributes(other PathMetadata, flags RestorableMetadataFlag) bool

+ func (p *PathMetadata) MTime() time.Time

+ type ProtobufBytesWriter struct

+ func NewProtobufWriter(out []byte) *ProtobufBytesWriter

+ func (w *ProtobufBytesWriter) Bytes() []byte

+ func (w *ProtobufBytesWriter) WriteBytes(field int, v []byte) error

+ func (w *ProtobufBytesWriter) WriteMessage(field int, marshall func(ProtobufWriter) error) error

+ func (w *ProtobufBytesWriter) WriteTag(field, wireType int) error

+ func (w *ProtobufBytesWriter) WriteUint64(field int, v uint64) error

+ func (w *ProtobufBytesWriter) WriteVarint(v_ int64) error

+ type ProtobufReader struct

+ func NewProtobufReader(in []byte) *ProtobufReader

+ func (r *ProtobufReader) AtEnd() bool

+ func (r *ProtobufReader) ReadBytes() ([]byte, error)

+ func (r *ProtobufReader) ReadTag() (int, int, error)

+ func (r *ProtobufReader) ReadUint32() (uint32, error)

+ func (r *ProtobufReader) ReadUint64() (uint64, error)

+ func (r *ProtobufReader) ReadVarint() (int64, error)

+ func (r *ProtobufReader) Skip(wireType int) error

+ type ProtobufSizeWriter struct

+ func NewProtobufSizeWriter() *ProtobufSizeWriter

+ func (w *ProtobufSizeWriter) Size() int

+ func (w *ProtobufSizeWriter) WriteBytes(field int, v []byte) error

+ func (w *ProtobufSizeWriter) WriteMessage(field int, marshall func(ProtobufWriter) error) error

+ func (w *ProtobufSizeWriter) WriteTag(field, wireType int) error

+ func (w *ProtobufSizeWriter) WriteUint64(field int, v uint64) error

+ func (w *ProtobufSizeWriter) WriteVarint(v int64) error

+ type ProtobufWriter interface

+ WriteBytes func(field int, v []byte) error

+ WriteMessage func(field int, marshall func(ProtobufWriter) error) error

+ WriteTag func(field, wireType int) error

+ WriteUint64 func(field int, v uint64) error

+ WriteVarint func(v int64) error

+ type RawKey [RawKeySize]byte

+ func DeriveUserKey(passphrase []byte, argon2id Argon2id) (RawKey, error)

+ func NewRawKey() (RawKey, error)

+ type RealFS struct — darwin/amd64, linux/amd64, windows/amd64

+ BasePath string

+ func NewRealFS(basePath string) *RealFS

+ func (f *RealFS) Chmod(name string, mode fs.FileMode) error

+ func (f *RealFS) Chmtime(name string, mtime time.Time) error

+ func (f *RealFS) Chown(name string, uid int, gid int) error

+ func (f *RealFS) FSync(file io.WriteCloser) error

+ func (f *RealFS) FSyncDir(path string) error

+ func (f *RealFS) Lock(ctx context.Context, path string) (unlock func() error, err error)

+ func (f *RealFS) MkSub(path string) (FS, error)

+ func (f *RealFS) Mkdir(name string) error

+ func (f *RealFS) MkdirAll(path string) error

+ func (f *RealFS) OpenRead(name string) (io.ReadCloser, error)

+ func (f *RealFS) OpenWrite(name string) (io.WriteCloser, error)

+ func (f *RealFS) OpenWriteExcl(name string) (io.WriteCloser, error)

+ func (f *RealFS) ReadDir(name string) ([]fs.DirEntry, error)

+ func (f *RealFS) ReadLink(name string) (string, error)

+ func (f *RealFS) Remove(name string) error

+ func (f *RealFS) RemoveAll(path string) error

+ func (f *RealFS) Rename(oldpath, newpath string) error

+ func (f *RealFS) Stat(name string) (fs.FileInfo, error)

+ func (f *RealFS) String() string

+ func (f *RealFS) Sub(path string) (FS, error)

+ func (f *RealFS) Symlink(target string, name string) error

+ func (f *RealFS) WalkDir(path string, fn fs.WalkDirFunc) error

+ type Repository struct

+ func InitNewRepository(ctx context.Context, storage Storage, passphrase []byte, kdf Argon2idParams) (*Repository, error)

+ func OpenRepository(ctx context.Context, storage Storage, passphrase []byte) (*Repository, error)

+ func (r *Repository) Close() error

+ func (r *Repository) GearCDCTable() GearCDCTable

+ func (r *Repository) Head(ctx context.Context) (RevisionId, error)

+ func (r *Repository) ReadBlock(ctx context.Context, blockId BlockId, buf BlockBuf) ([]byte, error)

+ func (r *Repository) ReadRevision(ctx context.Context, revisionId RevisionId, buf BlockBuf) (Revision, error)

+ func (r *Repository) WriteBlock(ctx context.Context, data []byte, buf BlockBuf) (blockId BlockId, dataBytesWritten *int, err error)

+ func (r *Repository) WriteRevision(ctx context.Context, revision *Revision) (RevisionId, error)

+ type RepositorySyncMonitor interface

+ OnBeforeCopy func(srcBlocks, dstBlocks int)

+ OnBeforeUpdateDstHead func(newHead RevisionId)

+ OnCopyBlock func(blockId BlockId, existed bool, length int)

+ OnDstBlockIdsRead func(blocksTotal int)

+ OnSrcBlockIdsRead func(blocksTotal int)

+ type RepositorySyncOptions struct

+ Monitor RepositorySyncMonitor

+ SkipHeadCheck bool

+ Workers int

+ type RestorableMetadataFlag uint8

+ const RestorableMetadataAll

+ const RestorableMetadataMTime

+ const RestorableMetadataMode

+ const RestorableMetadataOwnership

+ type Revision struct

+ Author *string

+ BlockIds []BlockId

+ Magic string

+ Message *string

+ ParentRevisionId RevisionId

+ Timestamp Timestamp

+ func UnmarshallRevision(r *ProtobufReader) (*Revision, error)

+ func (o *Revision) Marshall(w ProtobufWriter) error

+ func (o *Revision) MarshallSize() int

+ func (o *Revision) Validate() error

+ type RevisionChain []RevisionId

+ func ReadRevisionChain(ctx context.Context, repository *Repository) (RevisionChain, error)

+ func (chain RevisionChain) ParseRevisionId(spec string) (RevisionId, error)

+ func (chain RevisionChain) ParseRevisionRange(spec string) (RevisionRange, error)

+ type RevisionEntry struct

+ Kind RevisionEntryKind

+ Metadata PathMetadata

+ Path Path

+ func UnmarshallRevisionEntry(r *ProtobufReader) (*RevisionEntry, error)

+ func (o *RevisionEntry) Marshall(w ProtobufWriter) error

+ func (o *RevisionEntry) MarshallSize() int

+ func (o *RevisionEntry) Validate() error

+ type RevisionEntryChunk struct

+ Entries []*RevisionEntry

+ func UnmarshallRevisionEntryChunk(r *ProtobufReader) (*RevisionEntryChunk, error)

+ func (o *RevisionEntryChunk) Marshall(w ProtobufWriter) error

+ func (o *RevisionEntryChunk) MarshallSize() int

+ func (o *RevisionEntryChunk) Validate() error

+ type RevisionEntryKind uint32

+ const RevisionEntryKindAdd

+ const RevisionEntryKindDelete

+ const RevisionEntryKindUpdate

+ func (k RevisionEntryKind) String() string

+ type RevisionId BlockId

+ func ReadRef(ctx context.Context, storage Storage, name string) (RevisionId, error)

+ func (id RevisionId) IsInChain(chain RevisionChain) bool

+ func (id RevisionId) IsRoot() bool

+ func (id RevisionId) String() string

+ type RevisionRange struct

+ Since *RevisionId

+ Until *RevisionId

+ func (r RevisionRange) IsInChain(chain RevisionChain) bool

+ func (r RevisionRange) String() string

+ type RevisionReader struct

+ func NewRevisionReader(repository *Repository, revision *Revision) *RevisionReader

+ func (rr *RevisionReader) Read(ctx context.Context, buf BlockBuf) (*RevisionEntry, error)

+ type RevisionSnapshotMonitor interface

+ OnRevisionEntry func(entry *RevisionEntry)

+ OnRevisionStart func(revisionId RevisionId)

+ type Salt [32]byte

+ func NewSalt() (Salt, error)

+ type Sha256 [32]byte

+ func CalculateSha256(data []byte) Sha256

+ func (s Sha256) String() string

+ type Sha256Hmac Sha256

+ func CalculateHmac(data []byte, key RawKey) Sha256Hmac

+ type Storage interface

+ DeleteControlFile func(ctx context.Context, section ControlFileSection, name string) error

+ ForceUnlock func(ctx context.Context, name string) error

+ HasBlock func(ctx context.Context, blockId BlockId) (bool, error)

+ HasControlFile func(ctx context.Context, section ControlFileSection, name string) (bool, error)

+ Init func(ctx context.Context, config Toml, headerComment string) error

+ Lock func(ctx context.Context, name string) (func() error, error)

+ Open func(ctx context.Context) (Toml, error)

+ ReadBlock func(ctx context.Context, blockId BlockId, buf BlockBuf) ([]byte, error)

+ ReadBlockIds func(ctx context.Context, yield func(BlockId) bool) error

+ ReadControlFile func(ctx context.Context, section ControlFileSection, name string) ([]byte, error)

+ WriteBlock func(ctx context.Context, blockId BlockId, data []byte) (bool, error)

+ WriteControlFile func(ctx context.Context, section ControlFileSection, name string, data []byte) error

+ type StoragePurpose string

+ const StoragePurposeRepository

+ const StoragePurposeWorkspace

+ type Temp struct

+ func NewRevisionSnapshot(ctx context.Context, repository *Repository, revisionId RevisionId, tmpFS FS, ...) (*Temp[*RevisionEntry], error)

+ func OpenTemp[T any](fs FS, marshaller chunkMarshaller[T]) (*Temp[T], error)

+ func ReadSortedBlockIds(ctx context.Context, storage Storage, fs FS, inspect func(BlockId)) (*Temp[BlockId], error)

+ func (t *Temp[T]) Chunks() int

+ func (t *Temp[T]) Reader(filter func(T) bool) *TempReader[T]

+ func (t *Temp[T]) Remove() error

+ type TempCache struct

+ CacheMisses int

+ Source *Temp[T]

+ func NewRevisionEntryTempCache(temp *Temp[*RevisionEntry], maxChunksInCache int) (*TempCache[*RevisionEntry], error)

+ func NewTempCache[T any](temp *Temp[T], cacheKey func(T) string, maxChunksInCache int) (*TempCache[T], error)

+ func (tc *TempCache[T]) Get(key string) (T, bool, error)

+ type TempFrame struct

+ Data []byte

+ func UnmarshallTempFrame(r *ProtobufReader) (*TempFrame, error)

+ func (o *TempFrame) Marshall(w ProtobufWriter) error

+ func (o *TempFrame) MarshallSize() int

+ func (o *TempFrame) Validate() error

+ type TempReader struct

+ func (tr *TempReader[T]) Read(buf BlockBuf) (T, error)

+ func (tr *TempReader[T]) ReadChunk(i int, buf BlockBuf) ([]T, error)

+ type TempWriter struct

+ func NewBlockIdTempWriter(fs FS) *TempWriter[BlockId]

+ func NewRevisionEntryTempWriter(fs FS, maxChunkSize int) *TempWriter[*RevisionEntry]

+ func NewTempWriterWithIgnoreDuplicates[T any](compare func(a, b T) int, marshaller chunkMarshaller[T], fs FS, ...) *TempWriter[T]

+ func NewTempWriter[T any](compare func(a, b T) int, marshaller chunkMarshaller[T], fs FS, ...) *TempWriter[T]

+ func (tw *TempWriter[T]) Add(t T) error

+ func (tw *TempWriter[T]) Finalize() (*Temp[T], error)

+ type TestData struct — darwin/amd64, linux/amd64, windows/amd64

+ func (td TestData) Argon2idParams() Argon2idParams

+ func (td TestData) BlockId(suffix string) BlockId

+ func (td TestData) Column(s string, column int) string

+ func (td TestData) CommitInfo() *CommitInfo

+ func (td TestData) Dedent(s string) string

+ func (td TestData) EncryptedKey(suffix string) EncryptedKey

+ func (td TestData) NewFS(tb testing.TB) FS

+ func (td TestData) NewHealthCheckMonitor() *TestHealthCheckMonitor

+ func (td TestData) NewRealFS(tb testing.TB) *RealFS

+ func (td TestData) NewRevisionSnapshotMonitor() *TestRevisionSnapshotMonitor

+ func (td TestData) NewTestFS(tb testing.TB, fs FS) *TestFS

+ func (td TestData) NewTestRepository(tb testing.TB, fs FS) *TestRepository

+ func (td TestData) OpenRepository(tb testing.TB, fs FS) *TestRepository

+ func (td TestData) Path(p string) Path

+ func (td TestData) PathMetadata(mode FileMode) *PathMetadata

+ func (td TestData) RawKey(suffix string) RawKey

+ func (td TestData) Revision(parent RevisionId) *Revision

+ func (td TestData) RevisionChain(tb testing.TB, r *TestRepository) RevisionChain

+ func (td TestData) RevisionEntry(path string, entryType RevisionEntryKind) *RevisionEntry

+ func (td TestData) RevisionEntryExt(path string, entryType RevisionEntryKind, mode FileMode, content string) *RevisionEntry

+ func (td TestData) RevisionId(suffix string) RevisionId

+ func (td TestData) SHA256(content string) Sha256

+ func (td TestData) Sort(s string, column int) string

+ func (td TestData) Wc(option string, content string) int

+ type TestFS struct — darwin/amd64, linux/amd64, windows/amd64

+ func (f *TestFS) Cat(path string) string

+ func (f *TestFS) Chmod(path string, mode fs.FileMode)

+ func (f *TestFS) Chown(path string, uid int, gid int)

+ func (f *TestFS) Ls(path string) []TestFileInfo

+ func (f *TestFS) Mkdir(path string)

+ func (f *TestFS) MkdirAll(path string)

+ func (f *TestFS) PathMetadata(path string) *PathMetadata

+ func (f *TestFS) ReadLink(name string) string

+ func (f *TestFS) Rm(path string)

+ func (f *TestFS) RmAll(path string)

+ func (f *TestFS) Sha256(path string) Sha256

+ func (f *TestFS) Stat(path string) fs.FileInfo

+ func (f *TestFS) Symlink(target string, name string)

+ func (f *TestFS) Touch(path string, mtime time.Time)

+ func (f *TestFS) Write(path string, content string)

+ type TestFileInfo struct — darwin/amd64, linux/amd64, windows/amd64

+ Content string

+ Mode fs.FileMode

+ Path string

+ Size int

+ type TestHealthCheckMonitor struct — darwin/amd64, linux/amd64, windows/amd64

+ Calls []MockCall

+ func (m *TestHealthCheckMonitor) OnBlockVerified(blockId BlockId, length int)

+ func (m *TestHealthCheckMonitor) OnOrphanedBlock(blockId BlockId)

+ func (m *TestHealthCheckMonitor) OnRevisionEntry(entry *RevisionEntry)

+ func (m *TestHealthCheckMonitor) OnRevisionStart(revisionId RevisionId)

+ type TestRepository struct — darwin/amd64, linux/amd64, windows/amd64

+ Passphrase string

+ Storage *FileStorage

+ func (r *TestRepository) Head() RevisionId

+ func (r *TestRepository) RevisionEntryReaderInfos(read func(buf BlockBuf) (*RevisionEntry, error)) []TestRevisionEntryInfo

+ func (r *TestRepository) RevisionInfos(revisionId RevisionId) []TestRevisionEntryInfo

+ func (r *TestRepository) RevisionSnapshot(revisionId RevisionId, pathFilter PathFilter) []*RevisionEntry

+ func (r *TestRepository) RevisionSnapshotFileInfos(revisionId RevisionId, pathFilter PathFilter) []TestFileInfo

+ func (r *TestRepository) RevisionTempInfos(temp *Temp[*RevisionEntry]) []TestRevisionEntryInfo

+ type TestRevisionEntryInfo struct — darwin/amd64, linux/amd64, windows/amd64

+ Hash Sha256

+ Mode fs.FileMode

+ Path string

+ Type RevisionEntryKind

+ type TestRevisionSnapshotMonitor struct — darwin/amd64, linux/amd64, windows/amd64

+ Calls []MockCall

+ func (m *TestRevisionSnapshotMonitor) OnRevisionEntry(entry *RevisionEntry)

+ func (m *TestRevisionSnapshotMonitor) OnRevisionStart(revisionId RevisionId)

+ type Timestamp struct

+ Nsec uint32

+ Sec int64

+ func NewTimestampFromTime(t time.Time) Timestamp

+ func NewTimestampNow() Timestamp

+ func UnmarshallTimestamp(r *ProtobufReader) (*Timestamp, error)

+ func (o *Timestamp) Marshall(w ProtobufWriter) error

+ func (o *Timestamp) MarshallSize() int

+ func (o *Timestamp) Validate() error

+ func (t *Timestamp) Time() time.Time

+ type Toml map[string]map[string]string

+ func ReadToml(src io.Reader) (Toml, error)

+ func (t Toml) Eq(other Toml) bool

+ func (t Toml) GetIntValue(section string, key string) (int, bool)

+ func (t Toml) GetValue(section string, key string) (string, bool)

+ type UserKey RawKey

+ type WrappedError struct

+ Msg string

+ func Errorf(msg string, msgArgs ...any) *WrappedError

+ func WrapErrorf(err error, msg string, msgArgs ...any) *WrappedError

+ func (w *WrappedError) Error() string

+ func (w *WrappedError) Is(target error) bool

+ func (w *WrappedError) Unwrap() error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL