Documentation ¶
Overview ¶
Package db provides a set type to track local/remote files with newness checks. We must do a certain amount of normalization in here. We will get fed paths with either native or wire-format separators and encodings depending on who calls us. We transform paths to wire-format (NFC and slashes) on the way to the database, and transform to native format (varying separator and encoding) on the way back out.
Index ¶
- Constants
- func BlocksToSize(num int) int64
- func DropFolder(db *Instance, folder string)
- type BlockFinder
- type BlockMap
- type FileInfoTruncated
- type FileIntf
- type FileSet
- func (s *FileSet) Availability(file string) []protocol.DeviceID
- func (s *FileSet) Get(device protocol.DeviceID, file string) (protocol.FileInfo, bool)
- func (s *FileSet) GetGlobal(file string) (protocol.FileInfo, bool)
- func (s *FileSet) GetGlobalTruncated(file string) (FileInfoTruncated, bool)
- func (s *FileSet) GlobalSize() (files, deleted int, bytes int64)
- func (s *FileSet) LocalSize() (files, deleted int, bytes int64)
- func (s *FileSet) LocalVersion(device protocol.DeviceID) int64
- func (s *FileSet) Replace(device protocol.DeviceID, fs []protocol.FileInfo)
- func (s *FileSet) Update(device protocol.DeviceID, fs []protocol.FileInfo)
- func (s *FileSet) WithGlobal(fn Iterator)
- func (s *FileSet) WithGlobalTruncated(fn Iterator)
- func (s *FileSet) WithHave(device protocol.DeviceID, fn Iterator)
- func (s *FileSet) WithHaveTruncated(device protocol.DeviceID, fn Iterator)
- func (s *FileSet) WithNeed(device protocol.DeviceID, fn Iterator)
- func (s *FileSet) WithNeedTruncated(device protocol.DeviceID, fn Iterator)
- func (s *FileSet) WithPrefixedGlobalTruncated(prefix string, fn Iterator)
- func (s *FileSet) WithPrefixedHaveTruncated(device protocol.DeviceID, prefix string, fn Iterator)
- type Instance
- type Iterator
- type NamespacedKV
- func (n NamespacedKV) Bool(key string) (bool, bool)
- func (n NamespacedKV) Bytes(key string) ([]byte, bool)
- func (n NamespacedKV) Delete(key string)
- func (n *NamespacedKV) Int64(key string) (int64, bool)
- func (n *NamespacedKV) PutBool(key string, val bool)
- func (n *NamespacedKV) PutBytes(key string, val []byte)
- func (n *NamespacedKV) PutInt64(key string, val int64)
- func (n *NamespacedKV) PutString(key, val string)
- func (n *NamespacedKV) PutTime(key string, val time.Time)
- func (n *NamespacedKV) Reset()
- func (n NamespacedKV) String(key string) (string, bool)
- func (n NamespacedKV) Time(key string) (time.Time, bool)
- type VirtualMtimeRepo
Constants ¶
const ( KeyTypeDevice = iota KeyTypeGlobal KeyTypeBlock KeyTypeDeviceStatistic KeyTypeFolderStatistic KeyTypeVirtualMtime KeyTypeFolderIdx KeyTypeDeviceIdx )
Variables ¶
This section is empty.
Functions ¶
func BlocksToSize ¶
func DropFolder ¶
DropFolder clears out all information related to the given folder from the database.
Types ¶
type BlockFinder ¶
type BlockFinder struct {
// contains filtered or unexported fields
}
func NewBlockFinder ¶
func NewBlockFinder(db *Instance) *BlockFinder
func (*BlockFinder) Fix ¶
func (f *BlockFinder) Fix(folder, file string, index int32, oldHash, newHash []byte) error
Fix repairs incorrect blockmap entries, removing the old entry and replacing it with a new entry for the given block
func (*BlockFinder) Iterate ¶
func (f *BlockFinder) Iterate(folders []string, hash []byte, iterFn func(string, string, int32) bool) bool
Iterate takes an iterator function which iterates over all matching blocks for the given hash. The iterator function has to return either true (if they are happy with the block) or false to continue iterating for whatever reason. The iterator finally returns the result, whether or not a satisfying block was eventually found.
func (*BlockFinder) String ¶
func (f *BlockFinder) String() string
type BlockMap ¶
type BlockMap struct {
// contains filtered or unexported fields
}
func NewBlockMap ¶
type FileInfoTruncated ¶
func (*FileInfoTruncated) UnmarshalXDR ¶
func (o *FileInfoTruncated) UnmarshalXDR(bs []byte) error
func (*FileInfoTruncated) UnmarshalXDRFrom ¶ added in v0.13.0
func (o *FileInfoTruncated) UnmarshalXDRFrom(u *xdr.Unmarshaller) error
type FileIntf ¶
type FileIntf interface { Size() int64 IsDeleted() bool IsInvalid() bool IsDirectory() bool IsSymlink() bool HasPermissionBits() bool }
FileIntf is the set of methods implemented by both protocol.FileInfo and protocol.FileInfoTruncated.
type FileSet ¶
type FileSet struct {
// contains filtered or unexported fields
}
func NewFileSet ¶
func (*FileSet) GetGlobalTruncated ¶
func (s *FileSet) GetGlobalTruncated(file string) (FileInfoTruncated, bool)
func (*FileSet) GlobalSize ¶ added in v0.12.0
func (*FileSet) WithGlobal ¶
func (*FileSet) WithGlobalTruncated ¶
func (*FileSet) WithHaveTruncated ¶
func (*FileSet) WithNeedTruncated ¶
func (*FileSet) WithPrefixedGlobalTruncated ¶
type Instance ¶ added in v0.12.0
func OpenMemory ¶ added in v0.12.0
func OpenMemory() *Instance
func (*Instance) ListFolders ¶ added in v0.12.0
type Iterator ¶
The Iterator is called with either a protocol.FileInfo or a protocol.FileInfoTruncated (depending on the method) and returns true to continue iteration, false to stop.
type NamespacedKV ¶
type NamespacedKV struct {
// contains filtered or unexported fields
}
NamespacedKV is a simple key-value store using a specific namespace within a leveldb.
func NewNamespacedKV ¶
func NewNamespacedKV(db *Instance, prefix string) *NamespacedKV
NewNamespacedKV returns a new NamespacedKV that lives in the namespace specified by the prefix.
func (NamespacedKV) Bool ¶
func (n NamespacedKV) Bool(key string) (bool, bool)
Bool returns the stored value as a boolean and a boolean that is false if no value was stored at the key.
func (NamespacedKV) Bytes ¶
func (n NamespacedKV) Bytes(key string) ([]byte, bool)
Bytes returns the stored value as a raw byte slice and a boolean that is false if no value was stored at the key.
func (NamespacedKV) Delete ¶
func (n NamespacedKV) Delete(key string)
Delete deletes the specified key. It is allowed to delete a nonexistent key.
func (*NamespacedKV) Int64 ¶
func (n *NamespacedKV) Int64(key string) (int64, bool)
Int64 returns the stored value interpreted as an int64 and a boolean that is false if no value was stored at the key.
func (*NamespacedKV) PutBool ¶
func (n *NamespacedKV) PutBool(key string, val bool)
PutBool stores a new boolean. Any existing value (even if of another type) is overwritten.
func (*NamespacedKV) PutBytes ¶
func (n *NamespacedKV) PutBytes(key string, val []byte)
PutBytes stores a new byte slice. Any existing value (even if of another type) is overwritten.
func (*NamespacedKV) PutInt64 ¶
func (n *NamespacedKV) PutInt64(key string, val int64)
PutInt64 stores a new int64. Any existing value (even if of another type) is overwritten.
func (*NamespacedKV) PutString ¶
func (n *NamespacedKV) PutString(key, val string)
PutString stores a new string. Any existing value (even if of another type) is overwritten.
func (*NamespacedKV) PutTime ¶
func (n *NamespacedKV) PutTime(key string, val time.Time)
PutTime stores a new time.Time. Any existing value (even if of another type) is overwritten.
func (*NamespacedKV) Reset ¶
func (n *NamespacedKV) Reset()
Reset removes all entries in this namespace.
type VirtualMtimeRepo ¶
type VirtualMtimeRepo struct {
// contains filtered or unexported fields
}
func NewVirtualMtimeRepo ¶
func NewVirtualMtimeRepo(ldb *Instance, folder string) *VirtualMtimeRepo
func (*VirtualMtimeRepo) DeleteMtime ¶
func (r *VirtualMtimeRepo) DeleteMtime(path string)
func (*VirtualMtimeRepo) Drop ¶
func (r *VirtualMtimeRepo) Drop()
func (*VirtualMtimeRepo) UpdateMtime ¶
func (r *VirtualMtimeRepo) UpdateMtime(path string, diskMtime, actualMtime time.Time)