flatfs

Jan 13, 2026

Changes in this version

+ type BatchReader interface

+ type DiscardableBatch interface

+ Discard func(ctx context.Context) error

Apr 17, 2020

Changes in this version

+ var RetryAttempts = 6

Apr 10, 2020

Changes in this version

+ var RetryDelay = time.Millisecond * 200

Feb 14, 2020

Changes in this version

+ var ErrInvalidKey = errors.New("key not supported by flatfs")

Dec 3, 2019

Changes in this version

type Datastore

+ func (fs *Datastore) Sync(prefix datastore.Key) error

Mar 16, 2019

Changes in this version

+ var ErrClosed = errors.New("datastore closed")

Mar 1, 2019

Changes in this version

+ const PREFIX

+ const README_FN

+ const SHARDING_FN

+ const SyncThreadsMax

+ var DiskUsageCalcTimeout = 5 * time.Minute

+ var DiskUsageFile = "diskUsage.cache"

+ var DiskUsageFilesAverage = 2000

+ var ErrDatastoreDoesNotExist = errors.New("datastore directory does not exist")

+ var ErrDatastoreExists = errors.New("datastore already exists")

+ var ErrShardingFileMissing = fmt.Errorf("%s file not found in datastore", SHARDING_FN)

+ var IPFS_DEF_SHARD = NextToLast(2)

+ var IPFS_DEF_SHARD_STR = IPFS_DEF_SHARD.String()

+ var README_IPFS_DEF_SHARD = ...

+ func Create(path string, fun *ShardIdV1) error

+ func DirIsEmpty(name string) (bool, error)

+ func DowngradeV1toV0(path string) error

+ func Move(oldPath string, newPath string, out io.Writer) error

+ func UpgradeV0toV1(path string, prefixLen int) error

+ func WriteReadme(dir string, id *ShardIdV1) error

+ func WriteShardFunc(dir string, id *ShardIdV1) error

+ type Datastore struct

+ func CreateOrOpen(path string, fun *ShardIdV1, sync bool) (*Datastore, error)

+ func Open(path string, syncFiles bool) (*Datastore, error)

+ func (*Datastore) IsThreadSafe()

+ func (fs *Datastore) Accuracy() string

+ func (fs *Datastore) Batch() (datastore.Batch, error)

+ func (fs *Datastore) Close() error

+ func (fs *Datastore) Delete(key datastore.Key) error

+ func (fs *Datastore) DiskUsage() (uint64, error)

+ func (fs *Datastore) Get(key datastore.Key) (value []byte, err error)

+ func (fs *Datastore) GetSize(key datastore.Key) (size int, err error)

+ func (fs *Datastore) Has(key datastore.Key) (exists bool, err error)

+ func (fs *Datastore) Put(key datastore.Key, value []byte) error

+ func (fs *Datastore) Query(q query.Query) (query.Results, error)

+ func (fs *Datastore) ShardStr() string

+ type ShardFunc func(string) string

+ type ShardIdV1 struct

+ func NextToLast(suffixLen int) *ShardIdV1

+ func ParseShardFunc(str string) (*ShardIdV1, error)

+ func Prefix(prefixLen int) *ShardIdV1

+ func ReadShardFunc(dir string) (*ShardIdV1, error)

+ func Suffix(suffixLen int) *ShardIdV1

+ func (f *ShardIdV1) Func() ShardFunc

+ func (f *ShardIdV1) String() string