unixfs_sync

func CleanPathListForFilter ¶

func CleanPathListForFilter(pathList []string) []string

CleanPathListForFilter cleans the given list of paths for NewFilterFileList.

Sorts and cleans the paths. Strips any leading '/'.

func Sync ¶

func Sync(
	ctx context.Context,
	outPath string,
	fsHandle *unixfs.FSHandle,
	deleteMode DeleteMode,
	filterCb FilterCb,
) error

Sync recursively synchronizes the contents of the UnixFS to disk.

Attempts to skip files by checking size and modification time. The output path does not have to be empty when starting. filterCb is optional and is called with each element in the fs tree. TODO: Does not (yet) support symlinks or other non-file and non-dir node types.

func SyncFromDisk ¶

func SyncFromDisk(
	ctx context.Context,
	destHandle *unixfs.FSHandle,
	srcPath string,
	deleteMode DeleteMode,
	filterCb FilterCb,
) error

SyncFromDisk syncs from disk to the given UnixFS FSHandle.

func SyncFromFS ¶

func SyncFromFS(
	ctx context.Context,
	destHandle *unixfs.FSHandle,
	srcFs fs.FS,
	deleteMode DeleteMode,
	filterCb FilterCb,
) error

SyncFromFS syncs from the given fs.FS to the UnixFS FSHandle.

func SyncToBilly ¶

func SyncToBilly(
	ctx context.Context,
	bfs BillyFS,
	fsHandle *unixfs.FSHandle,
	deleteMode DeleteMode,
	filterCb FilterCb,
) error

SyncToBilly recursively synchronizes the contents of the UnixFS to a BillyFS.

Attempts to skip files by checking size and modification time. The output path does not have to be empty when starting. TODO: Node types other than directory, regular file, and symlink are not supported.

func SyncToBillyContents ¶

func SyncToBillyContents(
	ctx context.Context,
	bfs BillyFS,
	fsHandle *unixfs.FSHandle,
	deleteMode DeleteMode,
	filterCb FilterCb,
	changeCb ChangeCb,
) error

SyncToBillyContents compares regular-file bytes even when size and mtime match. Unchanged files are left intact so source watchers only observe actual edits. changeCb, if set, observes each destination file the sync changes.

func SyncToUnixfs ¶

func SyncToUnixfs(
	ctx context.Context,
	dest,
	src *unixfs.FSHandle,
	deleteMode DeleteMode,
	filterCb FilterCb,
) error

SyncToUnixfs recursively synchronizes the contents of the UnixFS to another UnixFS.

Attempts to skip files by checking size and modification time. The output path does not have to be empty when starting. Directories, regular files, and symlinks are supported; other node types (FIFO, device, socket, etc.) are still skipped.

func SyncToUnixfsBatch ¶

func SyncToUnixfsBatch(
	ctx context.Context,
	b *unixfs_world.BatchFSWriter,
	src *unixfs.FSHandle,
	filterCb FilterCb,
) error

SyncToUnixfsBatch walks a source FSHandle and drives a BatchFSWriter, accumulating file content blobs eagerly and committing every directory merge in a single world-object transaction. Mirrors SyncToUnixfs in semantics but collapses the per-op 2N+1 btx.Write amplification to N+1.

The destination root directory must already exist in the batch writer's world object (e.g. via FsInit). On error, the batch writer is Released to drop accumulated state; on success, Commit is called exactly once.

The source handle must point at a directory; lone file or symlink sources are not supported.

func SyncXattrs ¶

func SyncXattrs(
	ctx context.Context,
	outPath string,
	fsHandle *unixfs.FSHandle,
) error

SyncXattrs applies extended attributes from the source UnixFS tree to the files on disk at outPath. Call after Sync to preserve xattrs. This is a separate pass because billy.Filesystem does not support xattrs.