filesystem

package

Go to main page

Versions in this module

v0

v0.5.0

Oct 11, 2026

Changes in this version

+ const LedgerUnit

+ func JudgeChunk(own, in ChunkRecord, peerWinsTie bool) (accept, conflict bool)

+ func LoadSidecar(path string, expectedFileSize int64) (*ChunkBitmap, *SidecarMeta, error)

+ func SaveSidecar(path string, bm *ChunkBitmap, meta *SidecarMeta) error

+ type ChunkLedger struct

+ func NewChunkLedger(size int64) *ChunkLedger

+ func (l *ChunkLedger) AnyDirty() bool

+ func (l *ChunkLedger) Apply(c int, in ChunkRecord)

+ func (l *ChunkLedger) Clean()

+ func (l *ChunkLedger) Diff(peer []ChunkRecord, peerWinsTie bool) (fetch, conflicts []int)

+ func (l *ChunkLedger) DirtyBase() (base int64, ok bool)

+ func (l *ChunkLedger) Judge(c int, in ChunkRecord, peerWinsTie bool) (accept, conflict bool)

+ func (l *ChunkLedger) Len() int

+ func (l *ChunkLedger) MarkWritten(c int, base ChunkRecord)

+ func (l *ChunkLedger) MaxDirtyStamp() int64

+ func (l *ChunkLedger) Record(c int) (rec ChunkRecord, ok bool)

+ func (l *ChunkLedger) RecordRange(offset int64, n int) (first, last int)

+ func (l *ChunkLedger) Records() []ChunkRecord

+ func (l *ChunkLedger) Settle(c int, hash uint64, stamp int64)

+ func (l *ChunkLedger) SettleDirty(stamp int64)

+ func (l *ChunkLedger) SettleSwap(temp *ChunkLedger, stamp int64) (changed []int)

+ func (l *ChunkLedger) Size() int64

+ type ChunkRecord struct

+ Author uint8

+ BaseHash uint64

+ BaseStamp int64

+ Dirty bool

+ Hash uint64

+ Present bool

+ Stamp int64

type Dir

+ func (d *Dir) LocalAuthority(path string) (known, local bool)

+ func (d *Dir) SetOnDestroy(fn func())

type FS

+ func (fs *FS) PeerChanged(p string, c PeerChange)

type File

+ AnnounceAfterFill bool

+ Ledger *ChunkLedger

+ WireBytes atomic.Uint64

type OpenFileCounter

+ func (ofc *OpenFileCounter) Reset()

+ type PeerChange uint8

+ const PeerAdded

+ const PeerDirAdded

+ const PeerDirRemoved

+ const PeerEdited

+ const PeerRemoved

+ type SidecarMeta struct

+ EditBase int64

+ HeldStamp int64

+ Ledger *ChunkLedger

v0.4.8

Sep 15, 2026

v0.4.7

Sep 10, 2026

Changes in this version

+ const LowDiskFloor

+ const ProbeFetch

+ const SlowFetchNotice

type Dir

+ func (d *Dir) LowDisk() bool

+ func (d *Dir) SetOnLowDisk(fn func(low bool, free uint64))

+ func (d *Dir) SetOnSlowFetch(fn func(waited time.Duration))

type FS

+ OnLowDisk func(low bool, free uint64)

+ OnSlowFetch func(waited time.Duration)

type StreamPool

+ func (p *StreamPool) ReadAtBulk(ctx context.Context, offset int64, size int64) ([]byte, error)

v0.4.6

Sep 8, 2026

v0.4.5

Sep 6, 2026

Changes in this version

type FS

+ OnRootReady func()

v0.4.4

Sep 5, 2026

v0.4.3

Sep 4, 2026

Changes in this version

type Dir

+ TieBreakPeerWins atomic.Bool

+ func NewBareRoot(saveDir string) *Dir

+ func (d *Dir) CrossingDirMove(inOld, inNew string) (bool, string, string)

+ func (d *Dir) ForgetLocalDirMove(newpath string)

+ func (d *Dir) PreserveConflictSiblingForDelete(logger *slog.Logger, path string) (string, error)

+ func (d *Dir) RecordLocalDirMove(oldpath, newpath string)

+ func (d *Dir) RekeyChildren(oldpath, newpath string)

+ func (d *Dir) UndoLocalDirMove(movedTo, movedFrom string) error

+ func (d *Dir) UnsyncedConflictSiblings() [][2]string

type FS

+ TieBreakPeerWins atomic.Bool

+ func (fs *FS) SetTieBreakPeerWins(peerWins bool)

v0.4.2

Aug 25, 2026

Changes in this version

+ const SmallFileWarmThreshold

+ const WarmBatchBudget

+ const WarmBatchMaxFiles

v0.4.1

Aug 16, 2026

Changes in this version

+ func ApplyOriginMetadata(path string, mode uint32, atimeNs, mtimeNs int64) error

type Dir

+ MountReadOnly bool

+ PreserveMetadata bool

+ func (d *Dir) PreserveMeta() bool

+ func (d *Dir) ReadOnlyMount() bool

type FS

+ MountReadOnly bool

+ PreserveMetadata bool

type File

+ OriginAtimeNs int64

+ OriginMode uint32

+ OriginMtimeNs int64

v0.4.0

Aug 6, 2026

Changes in this version

+ func DumpHandlesFor(pathSuffix string) — windows/amd64

+ func OpenShared(path string, flags int, mode uint32) (*os.File, error)

+ func RenameShared(oldpath, newpath string) error

type Dir

+ func (d *Dir) AddRemoteFileWithBase(logger *slog.Logger, path string, name string, stat *winfuse.Stat_t, ...) error

+ func (d *Dir) Ctx() context.Context

+ func (d *Dir) EditRemoteFileWithBase(logger *slog.Logger, path string, name string, stat *winfuse.Stat_t, ...) error

+ func (d *Dir) PendingAnnounceSuperseded(path string) bool

+ func (d *Dir) SetCallbacks(onLocalChange func(event types.FileEvent), ...)

+ func (d *Dir) SetCtx(ctx context.Context)

+ func (d *Dir) SetOnLocalChange(fn func(event types.FileEvent))

+ func (d *Dir) SetStreamProvider(fn func() types.FileStreamProvider)

+ func (d *Dir) StreamProviderFn() func() types.FileStreamProvider

+ func (d *Dir) SwapWouldConflict(path string, baseMtimeNs int64) bool

type FS

+ func (fs *FS) SetRoot(root *Dir)

type File

+ EditBaseMtimeNs int64

+ HeldMtimeNs int64

+ LastAnnouncedMtimeNs int64

+ RemoteMtimeNs int64

v0.3.6

Jun 28, 2026

Changes in this version

type ChunkBitmap

+ func (b *ChunkBitmap) Clear(chunkIdx int)

+ func (b *ChunkBitmap) ClearRange(offset int64, size int)

+ func (b *ChunkBitmap) HasHashes() bool

+ func (b *ChunkBitmap) Hash(chunkIdx int) (uint64, bool)

+ func (b *ChunkBitmap) SetHash(chunkIdx int, h uint64)

type Dir

+ ReadAheadWindowBlocks int

type FS

+ ReadAheadWindowMB int

+ func (fs *FS) CancelInFlight()

+ func (fs *FS) EnsurePeerScope(fp string)

v0.3.5

Jun 17, 2026

Changes in this version

+ const ReadAheadBlock

v0.3.4

Jun 7, 2026

v0.3.3

Jun 6, 2026

Changes in this version

type Dir

+ PrefetchAutoMB int

type FS

+ AutoCache bool

+ PrefetchAutoMB int

type OpenFileCounter

+ func (ofc *OpenFileCounter) OpenIfActive() bool

v0.3.2

May 31, 2026

Changes in this version

type Dir

+ FsCtx context.Context

type FS

+ func (fs *FS) ClearFiles()

+ func (fs *FS) IsMounted() bool

+ func (fs *FS) RefreshCallbacks()

v0.3.0

May 23, 2026

v0.2.0

May 3, 2026

v0.1.1

Apr 27, 2026

v0.1.0

Apr 25, 2026

Changes in this version

+ const ChunkSize

+ const FilesystemBlockSize — darwin/amd64, linux/amd64, windows/amd64

+ const StreamPoolSize

+ func BitmapPath(filePath string) string

+ func GetFreeDiskSpace(path string) (freeBytesAvail, totalNumberOfBytes, totalNumberFreeBytes uint64, err error) — darwin/amd64, linux/amd64, windows/amd64

+ type ChunkBitmap struct

+ func LoadChunkBitmap(path string, expectedFileSize int64) (*ChunkBitmap, error)

+ func NewChunkBitmap(fileSize int64) *ChunkBitmap

+ func NewChunkBitmapWithSize(fileSize int64, chunkSize int) *ChunkBitmap

+ func (b *ChunkBitmap) ChunkSizeBytes() int

+ func (b *ChunkBitmap) FileSize() int64

+ func (b *ChunkBitmap) Has(chunkIdx int) bool

+ func (b *ChunkBitmap) HasRange(offset int64, size int) bool

+ func (b *ChunkBitmap) Have() int

+ func (b *ChunkBitmap) IsComplete() bool

+ func (b *ChunkBitmap) NextMissing(from int) int

+ func (b *ChunkBitmap) Progress() float64

+ func (b *ChunkBitmap) Save(path string) error

+ func (b *ChunkBitmap) Set(chunkIdx int)

+ func (b *ChunkBitmap) SetRange(offset int64, size int)

+ func (b *ChunkBitmap) Total() int

+ type Dir struct

+ Adm sync.RWMutex

+ AfmLock sync.RWMutex

+ AllDirMap map[string]*Dir

+ AllFileMap map[string]*File

+ Inode uint64

+ IsLocalPresent bool

+ LocalDownloadFolder string

+ Name string

+ OnLocalChange func(event types.FileEvent)

+ OpenFileHandlers map[uint64]*HandleEntry

+ OpenMapLock sync.RWMutex

+ OpenStreamProvider func() types.FileStreamProvider

+ Parent *Dir

+ PeerLastEdit uint64

+ PrefetchOnOpen bool

+ PrefetchSem chan struct{}

+ PushOnWrite bool

+ RealPathOfFile string

+ RelativePath string

+ RemoteFiles map[string]*File

+ RemoteFilesLock sync.RWMutex

+ Root *Dir

+ func (d *Dir) Access(path string, _mask uint32) (errCode int)

+ func (d *Dir) AddRemoteFile(logger *slog.Logger, path string, name string, stat *winfuse.Stat_t) error

+ func (d *Dir) Chmod(path string, mode uint32) (errCode int)

+ func (d *Dir) Chown(path string, uid uint32, gid uint32) (errCode int)

+ func (d *Dir) Create(path string, flags int, mode uint32) (errCode int, fh uint64)

+ func (d *Dir) CreateEx(path string, mode uint32, fi *winfuse.FileInfo_t) (errCode int)

+ func (d *Dir) Destroy()

+ func (d *Dir) EditRemoteFile(logger *slog.Logger, path string, name string, stat *winfuse.Stat_t) error

+ func (d *Dir) Flush(path string, fh uint64) (errCode int)

+ func (d *Dir) Fsync(path string, datasync bool, fh uint64) (errCode int)

+ func (d *Dir) Fsyncdir(path string, datasync bool, fh uint64) (errCode int)

+ func (d *Dir) Getattr(path string, stat *winfuse.Stat_t, fh uint64) (errCode int)

+ func (d *Dir) Getxattr(path string, name string) (errCode int, data []byte)

+ func (d *Dir) Init()

+ func (d *Dir) Link(oldpath string, newpath string) (errCode int)

+ func (d *Dir) Listxattr(path string, fill func(name string) bool) (errCode int)

+ func (d *Dir) Mkdir(path string, mode uint32) (errCode int)

+ func (d *Dir) MkdirFromPeer(path string, mode uint32) (errCode int)

+ func (d *Dir) Mknod(path string, mode uint32, dev uint64) (errCode int)

+ func (d *Dir) Open(path string, flags int) (errCode int, retFh uint64)

+ func (d *Dir) OpenEx(path string, fi *winfuse.FileInfo_t) (errCode int)

+ func (d *Dir) Opendir(path string) (errCode int, retFh uint64)

+ func (d *Dir) Read(path string, buff []byte, offset int64, fh uint64) (errCode int)

+ func (d *Dir) Readdir(path string, fill func(name string, stat *winfuse.Stat_t, offset int64) bool, ...) (errCode int)

+ func (d *Dir) Readlink(path string) (errCode int, target string)

+ func (d *Dir) Release(path string, fh uint64) (errCode int)

+ func (d *Dir) Releasedir(path string, fh uint64) (errCode int)

+ func (d *Dir) Removexattr(path string, name string) (errCode int)

+ func (d *Dir) Rename(oldpath string, newpath string) (errCode int)

+ func (d *Dir) Rmdir(path string) (errCode int)

+ func (d *Dir) RmdirFromPeer(path string) (errCode int)

+ func (d *Dir) Setxattr(path string, name string, value []byte, flags int) (errCode int)

+ func (d *Dir) Statfs(path string, stat *winfuse.Statfs_t) (errCode int)

+ func (d *Dir) Symlink(target string, newpath string) (errCode int)

+ func (d *Dir) Truncate(path string, size int64, fh uint64) (errCode int)

+ func (d *Dir) Unlink(path string) (errCode int)

+ func (d *Dir) UnlinkFromPeer(path string) (errCode int)

+ func (d *Dir) Utimens(path string, tmsp []winfuse.Timespec) (errCode int)

+ func (d *Dir) Write(path string, buff []byte, offset int64, fh uint64) (errCode int)

+ type DownloadState struct

+ AttemptCount atomic.Int32

+ BytesDownloaded atomic.Uint64

+ LastReadOffset atomic.Int64

+ LastSuccessAt atomic.Int64

+ MaxRetries int

+ StartedAt atomic.Int64

+ TotalSize atomic.Uint64

+ func (ds *DownloadState) CanRetry() bool

+ func (ds *DownloadState) Checksum() uint64

+ func (ds *DownloadState) IsComplete() bool

+ func (ds *DownloadState) Progress() float64

+ func (ds *DownloadState) RecordAttempt() int32

+ func (ds *DownloadState) Reset(totalSize uint64)

+ func (ds *DownloadState) UpdateChecksum(data []byte)

+ func (ds *DownloadState) UpdateProgress(offset int64, bytesRead int)

+ type FS struct

+ OnLocalChange func(event types.FileEvent)

+ OpenStreamProvider func() types.FileStreamProvider

+ PrefetchOnOpen bool

+ PushOnWrite bool

+ Root *Dir

+ func NewFS(logger *slog.Logger) *FS

+ func (fs *FS) Mount(mountPoint string, isSecond bool, downloadPath string)

+ func (fs *FS) Unmount()

+ type File struct

+ Bitmap *ChunkBitmap

+ CacheFD *os.File

+ CacheWg sync.WaitGroup

+ CreatedTime uint64

+ CurrentHandleID uint64

+ Download DownloadState

+ HadEdits bool

+ Inode uint64

+ IsLocalPresent bool

+ LastEditTime uint64

+ LastNotifiedSize int64

+ LocalNewer bool

+ Name string

+ NotLocalSynced bool

+ NotRemoteSynced bool

+ OnLocalChange func(event types.FileEvent)

+ Parent *Dir

+ PeerLastEdit uint64

+ PeerStoppedSharing bool

+ PrefetchCancel context.CancelFunc

+ RealPathOfFile string

+ RelativePath string

+ Root *Dir

+ StreamCancel context.CancelFunc

+ StreamPool *StreamPool

+ StreamProvider types.FileStreamProvider

+ WasTruncatedToZero bool

+ func (f *File) CountOpenDescriptors() uint64

+ func (f *File) NotifyPeer()

+ type HandleEntry struct

+ FD int

+ File *File

+ type OpenFileCounter struct

+ func (ofc *OpenFileCounter) CountOpenDescriptors() uint64

+ func (ofc *OpenFileCounter) Open()

+ func (ofc *OpenFileCounter) Release() uint64

+ type StreamPool struct

+ func NewStreamPool(provider types.FileStreamProvider, ctx context.Context, inode uint64, ...) (*StreamPool, error)

+ func (p *StreamPool) Close() error

+ func (p *StreamPool) ReadAt(ctx context.Context, offset int64, size int64) ([]byte, error)

+ type WriteStats struct

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