Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

filesync

package

Go to main page

Versions in this module

v0

v0.19.4

Oct 30, 2025

v0.19.3

Oct 23, 2025

Changes in this version

+ const XXH3

+ func Tracer(ctx context.Context) trace.Tracer

+ type CacheRefMetadata struct

+ type CachedChange = cache.Result[string, *ChangeWithStat]

+ type ChangeFunc func(kind ChangeKind, path string, lowerStat, upperStat *types.Stat) error

+ type ChangeKind = fsutil.ChangeKind

+ const ChangeKindAdd

+ const ChangeKindDelete

+ const ChangeKindModify

+ const ChangeKindNone

+ type ChangeWithStat struct

+ type ErrConflict struct

+ FieldName string

+ NewVal string

+ OldVal string

+ Path string

+ func (e *ErrConflict) Error() string

+ type FileSyncer struct

+ func NewFileSyncer(opt FileSyncerOpt) *FileSyncer

+ func (ls *FileSyncer) Snapshot(ctx context.Context, session session.Group, sm *session.Manager, ...) (bkcache.ImmutableRef, error)

+ type FileSyncerOpt struct

+ CacheAccessor bkcache.Accessor

+ type HashedStatInfo struct

+ func (s *HashedStatInfo) Digest() digest.Digest

+ type ReadFS interface

+ ReadFile func(ctx context.Context, path string) (io.ReadCloser, error)

+ type SnapshotOpts struct

+ CacheBuster string

+ ExcludePatterns []string

+ GitIgnore bool

+ IncludePatterns []string

+ RelativePath string

+ type StatInfo struct

+ func (s *StatInfo) Info() (fs.FileInfo, error)

+ func (s *StatInfo) IsDir() bool

+ func (s *StatInfo) ModTime() time.Time

+ func (s *StatInfo) Mode() os.FileMode

+ func (s *StatInfo) Name() string

+ func (s *StatInfo) Size() int64

+ func (s *StatInfo) Sys() any

+ func (s *StatInfo) Type() fs.FileMode

+ type WalkFS interface

+ Walk func(ctx context.Context, path string, walkFn fs.WalkDirFunc) error

v0.3.7

Dec 1, 2022

v0.3.6

Nov 30, 2022

v0.3.5

Nov 22, 2022

v0.3.4

Nov 10, 2022

v0.3.3

Nov 2, 2022

Changes in this version

+ var ErrIntOverflowFilesync = fmt.Errorf("proto: integer overflow")

+ var ErrInvalidLengthFilesync = fmt.Errorf("proto: negative length found during unmarshaling")

+ var ErrUnexpectedEndOfGroupFilesync = fmt.Errorf("proto: unexpected end of group")

+ func CopyFileWriter(ctx context.Context, md map[string]string, c session.Caller) (io.WriteCloser, error)

+ func CopyToCaller(ctx context.Context, fs fsutil.FS, c session.Caller, progress func(int, bool)) error

+ func FSSync(ctx context.Context, c session.Caller, opt FSSendRequestOpt) error

+ func NewFSSyncProvider(dirs DirSource) session.Attachable

+ func NewFSSyncTarget(f func(map[string]string) (io.WriteCloser, error)) session.Attachable

+ func NewFSSyncTargetDir(outdir string) session.Attachable

+ func RegisterFileSendServer(s *grpc.Server, srv FileSendServer)

+ func RegisterFileSyncServer(s *grpc.Server, srv FileSyncServer)

+ type BytesMessage struct

+ Data []byte

+ func (*BytesMessage) Descriptor() ([]byte, []int)

+ func (*BytesMessage) ProtoMessage()

+ func (m *BytesMessage) GetData() []byte

+ func (m *BytesMessage) Marshal() (dAtA []byte, err error)

+ func (m *BytesMessage) MarshalTo(dAtA []byte) (int, error)

+ func (m *BytesMessage) MarshalToSizedBuffer(dAtA []byte) (int, error)

+ func (m *BytesMessage) Reset()

+ func (m *BytesMessage) Size() (n int)

+ func (m *BytesMessage) Unmarshal(dAtA []byte) error

+ func (m *BytesMessage) XXX_DiscardUnknown()

+ func (m *BytesMessage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *BytesMessage) XXX_Merge(src proto.Message)

+ func (m *BytesMessage) XXX_Size() int

+ func (m *BytesMessage) XXX_Unmarshal(b []byte) error

+ func (this *BytesMessage) Equal(that interface{}) bool

+ func (this *BytesMessage) GoString() string

+ func (this *BytesMessage) String() string

+ type CacheUpdater interface

+ ContentHasher func() fsutil.ContentHasher

+ HandleChange func(fsutil.ChangeKind, string, os.FileInfo, error) error

+ MarkSupported func(bool)

+ type DirSource interface

+ LookupDir func(string) (SyncedDir, bool)

+ type FSSendRequestOpt struct

+ CacheUpdater CacheUpdater

+ DestDir string

+ Differ fsutil.DiffType

+ ExcludePatterns []string

+ Filter func(string, *fstypes.Stat) bool

+ FollowPaths []string

+ IncludePatterns []string

+ Name string

+ OverrideExcludes bool

+ ProgressCb func(int, bool)

+ type FileSendClient interface

+ DiffCopy func(ctx context.Context, opts ...grpc.CallOption) (FileSend_DiffCopyClient, error)

+ func NewFileSendClient(cc *grpc.ClientConn) FileSendClient

+ type FileSendServer interface

+ DiffCopy func(FileSend_DiffCopyServer) error

+ type FileSend_DiffCopyClient interface

+ Recv func() (*BytesMessage, error)

+ Send func(*BytesMessage) error

+ type FileSend_DiffCopyServer interface

+ Recv func() (*BytesMessage, error)

+ Send func(*BytesMessage) error

+ type FileSyncClient interface

+ DiffCopy func(ctx context.Context, opts ...grpc.CallOption) (FileSync_DiffCopyClient, error)

+ TarStream func(ctx context.Context, opts ...grpc.CallOption) (FileSync_TarStreamClient, error)

+ func NewFileSyncClient(cc *grpc.ClientConn) FileSyncClient

+ type FileSyncServer interface

+ DiffCopy func(FileSync_DiffCopyServer) error

+ TarStream func(FileSync_TarStreamServer) error

+ type FileSync_DiffCopyClient interface

+ Recv func() (*types.Packet, error)

+ Send func(*types.Packet) error

+ type FileSync_DiffCopyServer interface

+ Recv func() (*types.Packet, error)

+ Send func(*types.Packet) error

+ type FileSync_TarStreamClient interface

+ Recv func() (*types.Packet, error)

+ Send func(*types.Packet) error

+ type FileSync_TarStreamServer interface

+ Recv func() (*types.Packet, error)

+ Send func(*types.Packet) error

+ type InvalidSessionError struct

+ func (e InvalidSessionError) Error() string

+ func (e InvalidSessionError) Unwrap() error

+ type StaticDirSource map[string]SyncedDir

+ func (dirs StaticDirSource) LookupDir(name string) (SyncedDir, bool)

+ type Stream interface

+ Context func() context.Context

+ RecvMsg func(m interface{}) error

+ SendMsg func(m interface{}) error

+ type SyncedDir struct

+ Dir string

+ Excludes []string

+ Map func(string, *fstypes.Stat) bool

+ type UnimplementedFileSendServer struct

+ func (*UnimplementedFileSendServer) DiffCopy(srv FileSend_DiffCopyServer) error

+ type UnimplementedFileSyncServer struct

+ func (*UnimplementedFileSyncServer) DiffCopy(srv FileSync_DiffCopyServer) error

+ func (*UnimplementedFileSyncServer) TarStream(srv FileSync_TarStreamServer) error