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

gotfs

package

Go to main page

Versions in this module

v0

v0.4.0

May 7, 2026

Changes in this version

+ const DefaultContentCacheSize

+ const DefaultMetadataCacheSize

+ type DiffEntry struct

+ Key Key

+ Left maybe.Maybe[Value]

+ Right maybe.Maybe[Value]

+ type Entry struct

type Info

+ func (info *Info) Marshal(out []byte) []byte

+ func (info *Info) Unmarshal(data []byte) error

+ type InfoDiff struct

+ Left maybe.Maybe[Info]

+ Path string

+ Right maybe.Maybe[Info]

+ type InfoDiffer struct

+ func (it *InfoDiffer) Next(ctx context.Context, dst []InfoDiff) (int, error)

+ type Iterator struct

+ func (it *Iterator) Next(ctx context.Context, dst []Entry) (int, error)

type Key

+ func NewInfoKey(p string) (Key, error)

type Machine

+ func (m *Machine) NewIterator(s stores.RO, root Root, span Span) Iterator

+ func (mach *Machine) Concat(ctx context.Context, ss RW, segs iter.Seq[Segment]) (Segment, error)

+ func (mach *Machine) MetadataKV() *gotkv.Machine

+ func (mach *Machine) NewInfoDiffer(s stores.RO, left, right Root) InfoDiffer

+ func (mach *Machine) Pick(ctx context.Context, s stores.RW, root Root, p string) (*Root, error)

+ func (mach *Machine) ShiftOut(x Segment, p string) Segment

+ type Params struct

+ ContentCacheSize *int

+ MaxBlobSize *int

+ MeanBlobSizeData *int

+ MeanBlobSizeMetadata *int

+ MetaCacheSize *int

+ MinBlobSizeData *int

+ Salt [32]byte

+ func (p Params) GetContentCacheSize() int

+ func (p Params) GetMaxBlobSize() int

+ func (p Params) GetMeanBlobSizeData() int

+ func (p Params) GetMeanBlobSizeMetadata() int

+ func (p Params) GetMetaCacheSize() int

+ func (p Params) GetMinSizeData() int

+ type RO struct

+ Data stores.RO

+ Metadata stores.RO

+ type RW struct

+ Data stores.RW

+ Metadata stores.RW

+ func (rw RW) RO() RO

+ func (rw RW) WO() WO

type Root

+ func Promote(ctx context.Context, seg Segment) (*Root, error)

+ func (r Root) Segment() Segment

type Segment

+ func (s *Segment) Marshal(out []byte) []byte

+ func (s *Segment) Unmarshal(data []byte) error

+ type Value struct

+ Extent Extent

+ Info Info

+ type WO struct

+ Data stores.WO

+ Metadata stores.WO

v0.3.1

Feb 22, 2026

v0.3.0

Feb 8, 2026

Changes in this version

+ type InfoEntry struct

+ Info Info

+ Path string

+ type InfoIterator struct

+ func (it *InfoIterator) Next(ctx context.Context, dst []InfoEntry) (int, error)

type Machine

+ func (mach *Machine) ExistsDir(ctx context.Context, ms stores.Reading, root Root, p string) (bool, error)

+ func (mach *Machine) NewInfoIterator(s stores.RW, root Root) *InfoIterator

v0.2.0

Jan 29, 2026

v0.1.0

Jan 24, 2026

Changes in this version

+ const DefaultMaxBlobSize

+ const DefaultMeanBlobSizeData

+ const DefaultMeanBlobSizeMetadata

+ const DefaultMinBlobSizeData

+ const MaxPathLen

+ const RootSize

+ const Sep

+ func Dump(ctx context.Context, s stores.Reading, root Root, w io.Writer) error

+ func Equal(a, b Root) bool

+ func SpanForPath(p string) gotkv.Span

+ func SplitPath(p string) []string

+ type Builder struct

+ func (b *Builder) BeginFile(p string, mode os.FileMode) error

+ func (b *Builder) Finish() (*Root, error)

+ func (b *Builder) IsFinished() bool

+ func (b *Builder) Mkdir(p string, mode os.FileMode) error

+ func (b *Builder) Write(data []byte) (int, error)

+ type Delta gotkv.Root

+ type DeltaBuilder struct

+ func (db *DeltaBuilder) Delete(ctx context.Context, p string) error

+ func (db *DeltaBuilder) Finish(ctx context.Context) (*Delta, error)

+ func (db *DeltaBuilder) PutInfo(ctx context.Context, p string, info *Info) error

+ type DeltaEntry struct

+ Delete *struct{}

+ Path string

+ PutContent *PutContent

+ PutInfo *Info

+ type DeltaIterator struct

+ func (di *DeltaIterator) Next(ctx context.Context, dsts []DeltaEntry) (int, error)

+ type Differ struct

+ func (d *Differ) Next(ctx context.Context, dsts []DeltaEntry) (int, error)

+ type DirEnt struct

+ Mode os.FileMode

+ Name string

+ type Expr struct

+ AddPrefix string

+ Root Root

+ type Extent = gotlob.Extent

+ type GetPostExister interface

+ type Info struct

+ Attrs map[string][]byte

+ Mode fs.FileMode

+ type Key struct

+ func (k *Key) EndAt() uint64

+ func (k *Key) IsInfo() bool

+ func (k *Key) Path() string

+ func (k *Key) Unmarshal(data []byte) error

+ func (k Key) ChildrenSpan() gotkv.Span

+ func (k Key) Marshal(out []byte) []byte

+ func (k Key) Prefix(out []byte) []byte

+ type Machine struct

+ func NewMachine(opts ...Option) *Machine

+ func (mach *Machine) Check(ctx context.Context, s stores.Reading, root Root, ...) error

+ func (mach *Machine) CreateFile(ctx context.Context, ss [2]stores.RW, x Root, p string, r io.Reader) (*Root, error)

+ func (mach *Machine) Exists(ctx context.Context, ms stores.Reading, root Root, p string) (bool, error)

+ func (mach *Machine) FileFromReader(ctx context.Context, ss [2]stores.RW, mode posixfs.FileMode, r io.Reader) (*Root, error)

+ func (mach *Machine) FileFromReaders(ctx context.Context, ss [2]stores.RW, mode posixfs.FileMode, rs []io.Reader) (*Root, error)

+ func (mach *Machine) ForEach(ctx context.Context, s stores.Reading, root Root, p string, ...) error

+ func (mach *Machine) ForEachLeaf(ctx context.Context, s stores.Reading, root Root, p string, ...) error

+ func (mach *Machine) GetDirInfo(ctx context.Context, s stores.Reading, x Root, p string) (*Info, error)

+ func (mach *Machine) GetFileInfo(ctx context.Context, s stores.Reading, x Root, p string) (*Info, error)

+ func (mach *Machine) GetInfo(ctx context.Context, s stores.Reading, x Root, p string) (*Info, error)

+ func (mach *Machine) Graft(ctx context.Context, ss [2]stores.RW, root Root, p string, branch Root) (*Root, error)

+ func (mach *Machine) MaxInfo(ctx context.Context, ms stores.Reading, root Root, span Span) (string, *Info, error)

+ func (mach *Machine) MeanBlobSizeData() int

+ func (mach *Machine) MeanBlobSizeMetadata() int

+ func (mach *Machine) Mkdir(ctx context.Context, s stores.RW, x Root, p string) (*Root, error)

+ func (mach *Machine) MkdirAll(ctx context.Context, s stores.RW, x Root, p string) (*Root, error)

+ func (mach *Machine) NewBuilder(ctx context.Context, ms, ds stores.RW) *Builder

+ func (mach *Machine) NewDeltaBuilder(ms, ds stores.RW) *DeltaBuilder

+ func (mach *Machine) NewDeltaIterator(ms, ds stores.Reading, delta Delta) *DeltaIterator

+ func (mach *Machine) NewDiffer(ms stores.Reading, left, right Root) *Differ

+ func (mach *Machine) NewEmpty(ctx context.Context, s stores.RW) (*Root, error)

+ func (mach *Machine) NewReader(ctx context.Context, ss [2]stores.Reading, x Root, p string) (*Reader, error)

+ func (mach *Machine) Populate(ctx context.Context, s stores.Reading, root Root, mdSet, dataSet cadata.Set) error

+ func (mach *Machine) PutFile(ctx context.Context, ss [2]stores.RW, x Root, p string, r io.Reader) (*Root, error)

+ func (mach *Machine) PutInfo(ctx context.Context, s stores.RW, x Root, p string, md *Info) (*Root, error)

+ func (mach *Machine) ReadDir(ctx context.Context, s stores.Reading, x Root, p string, ...) error

+ func (mach *Machine) ReadFile(ctx context.Context, ss [2]stores.Reading, x Root, p string, max int) ([]byte, error)

+ func (mach *Machine) ReadFileAt(ctx context.Context, ss [2]stores.Reading, x Root, p string, start int64, ...) (int, error)

+ func (mach *Machine) RemoveAll(ctx context.Context, s Store, x Root, p string) (*Root, error)

+ func (mach *Machine) Select(ctx context.Context, s stores.RW, root Root, p string) (*Root, error)

+ func (mach *Machine) SizeOfFile(ctx context.Context, s stores.Reading, x Root, p string) (uint64, error)

+ func (mach *Machine) Splice(ctx context.Context, ss [2]stores.RW, segs []Segment) (*Root, error)

+ func (mach *Machine) Sync(ctx context.Context, src [2]stores.Reading, dst [2]stores.Writing, root Root) error

+ type Option func(a *Machine)

+ func WithContentCacheSize(n int) Option

+ func WithMetaCacheSize(n int) Option

+ func WithSalt(salt *[32]byte) Option

+ type PutContent struct

+ Begin uint64

+ End uint64

+ Extents []Extent

+ type Reader = gotlob.Reader

+ type Ref = gotkv.Ref

+ type Root struct

+ Depth uint8

+ Ref Ref

+ func ParseRoot(data []byte) (*Root, error)

+ func (r *Root) Unmarshal(data []byte) error

+ func (r Root) Marshal(out []byte) []byte

+ func (r Root) ToGotKV() gotkv.Root

+ type Segment struct

+ Contents Expr

+ Span gotkv.Span

+ func ChangesOnBase(base Root, changes []Segment) []Segment

+ func (s Segment) String() string

+ type Span = gotkv.Span

+ type Store = gotkv.Store