index

package

v0.0.9 Latest Latest Go to latest Published: Dec 1, 2025 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/signadot/tony-format

Links

Open Source Insights

Documentation ¶

Index ¶

func LogSegCompare(a, b LogSegment) int
func SortLogSegments(segments []*LogSegment)
func StoreIndex(path string, idx *Index) error
func WithinCommitRange(a, b *LogSegment) bool
type Index
type LogSegment
- func PointLogSegment(c, tx int64, p string) *LogSegment
type Tree
- func NewTree[T any](less func(a, b T) bool) *Tree[T]

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func LogSegCompare ¶

func LogSegCompare(a, b LogSegment) int

LogSegCompare compares 2 log segments by their start commit, start-tx, end-commit, end-tx, and path.

func SortLogSegments ¶

func SortLogSegments(segments []*LogSegment)

SortLogSegments sorts a slice of LogSegment pointers by commit count, then tx.

func StoreIndex ¶

func StoreIndex(path string, idx *Index) error

StoreIndex persists the index to the given path. It writes to a temporary file first and then atomically renames it to the target path.

func WithinCommitRange ¶ added in v0.0.9

func WithinCommitRange(a, b *LogSegment) bool

Types ¶

type Index ¶

type Index struct {
	sync.RWMutex
	Name     string // eg "" for root
	Commits  *Tree[LogSegment]
	Children map[string]*Index // map from subdir names to sub indices
}

func Build ¶

func Build(root string, extract func(path string) (*LogSegment, error)) (*Index, error)

Build reconstructs the index from the filesystem rooted at root. extract is a closure that takes a filesystem path and returns a LogSegment if the file represents one. If extract returns nil, the file is ignored.

func LoadIndex ¶

func LoadIndex(path string) (*Index, error)

LoadIndex loads the index from the given path.

func NewIndex ¶

func NewIndex(name string) *Index

func (*Index) Add ¶

func (i *Index) Add(seg *LogSegment)

func (*Index) GobDecode ¶

func (i *Index) GobDecode(data []byte) error

GobDecode implements the gob.GobDecoder interface.

func (*Index) GobEncode ¶

func (i *Index) GobEncode() ([]byte, error)

GobEncode implements the gob.GobEncoder interface. It flattens the Index into a list of LogSegments for serialization.

func (*Index) ListRange ¶ added in v0.0.9

func (i *Index) ListRange(from, to *int64) []string

ListRange returns the immediate child names at this index level. Returns the keys of the Children map.

func (*Index) LookupRange ¶

func (i *Index) LookupRange(vp string, from, to *int64) []LogSegment

func (*Index) Remove ¶

func (i *Index) Remove(seg *LogSegment) bool

type LogSegment ¶

type LogSegment struct {
	StartCommit int64
	StartTx     int64
	EndCommit   int64
	EndTx       int64
	RelPath     string
}

func PointLogSegment ¶

func PointLogSegment(c, tx int64, p string) *LogSegment

func (*LogSegment) AsPending ¶ added in v0.0.9

func (s *LogSegment) AsPending() *LogSegment

AsPending returns a copy of the segment with commit counts zeroed (for pending files).

func (*LogSegment) FromTony ¶ added in v0.0.9

func (s *LogSegment) FromTony(data []byte, opts ...gomap.UnmapOption) error

FromTony parses Tony format bytes and populates LogSegment.

func (*LogSegment) FromTonyIR ¶ added in v0.0.9

func (s *LogSegment) FromTonyIR(node *ir.Node, opts ...gomap.UnmapOption) error

FromTonyIR populates LogSegment from a Tony IR node.

func (*LogSegment) IsPoint ¶

func (s *LogSegment) IsPoint() bool

IsPoint returns true if and only if this log segment represents a diff from the preceding commit.

func (*LogSegment) String ¶ added in v0.0.9

func (s *LogSegment) String() string

func (*LogSegment) ToTony ¶ added in v0.0.9

func (s *LogSegment) ToTony(opts ...gomap.MapOption) ([]byte, error)

ToTony converts LogSegment to Tony format bytes.

func (*LogSegment) ToTonyIR ¶ added in v0.0.9

func (s *LogSegment) ToTonyIR(opts ...gomap.MapOption) (*ir.Node, error)

ToTonyIR converts LogSegment to a Tony IR node.

func (*LogSegment) WithCommit ¶ added in v0.0.9

func (s *LogSegment) WithCommit(commitCount int64) *LogSegment

WithCommit returns a copy of the segment with the commit count set. For point segments: sets both Start and End to commitCount. For compacted segments: keeps StartCommit, sets EndCommit to commitCount.

type Tree ¶

type Tree[T any] struct {
	Less func(a, b T) bool
	// contains filtered or unexported fields
}

func NewTree ¶

func NewTree[T any](less func(a, b T) bool) *Tree[T]

func (*Tree[T]) All ¶

func (t *Tree[T]) All(f func(T) bool) bool

All applies f to all elements in T in ascending order until f returns false. All returns whether or not f returns false

func (*Tree[T]) Index ¶

func (t *Tree[T]) Index(v T) int

func (*Tree[T]) Insert ¶

func (t *Tree[T]) Insert(v T) bool

func (*Tree[T]) Range ¶

func (t *Tree[T]) Range(f func(T) bool, r func(T) int) bool

Range applies f to all elements e such that r(e) == 0. r should return a negative integer for elements less than those such that r(e) == 0 and likewise a positive integer for those elements greater than those such that r(e) == 0

func (*Tree[T]) Remove ¶

func (t *Tree[T]) Remove(v T) bool

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL