compression

Documentation

Overview

Package compression implements the file-read compression pipeline that produces a token-optimized rendering of a file given Grove's symbols and the current session state.

Index

• Constants
• func Hash(content string) string
• func SymbolKey(s grove.SymbolRecord) string
• type Options
• type Result
  • func CompressFileRead(filePath, content string, opts Options) Result

Constants

const MaxTokensPerFile = 50000

MaxTokensPerFile caps the size of any single compressed file response.

Functions

func Hash

func Hash(content string) string

Hash returns the SHA-256 hex of content. Used as the cache key.

func SymbolKey

func SymbolKey(s grove.SymbolRecord) string

SymbolKey is the identity a symbol's SHA is stored under: the qualified name when present (unique within a file since Grove v0.6.0 qualifies members by parent), else the bare name. Keying by bare name alone made same-named members in one file (two receivers' Close()) collide, which could pointer a changed body inside a "lossless" delta.

Types

type Options

type Options struct {
	Task            string               // unused by file-read compression (see above)
	Symbols         []grove.SymbolRecord // symbols in this file (from Grove)
	Session         *session.Tracker
	Ledger          *session.Ledger
	TokenLedgerName string // tool name to bill ledger ("prism_read")
	Confidence      session.Confidence
	ContextUsed     int64                   // agent-reported context size at this call (0 = not reported)
	Embeddings      ranking.SemanticBackend // unused by file-read compression (see above)
}

Options configures CompressFileRead.

Task and Embeddings are retained for API compatibility and potential future use, but they intentionally do NOT influence a first read: Prism delivers the complete file on first read and never trims symbol bodies by relevance, since a lossy first-read reconstruction silently drops content the model has never seen. All compression happens on the safe re-read paths (sha-pointer and the lossless semantic delta), which key off Session state, not relevance.

type Result

type Result struct {
	FilePath        string
	Content         string
	Strategy        string // "full-fresh" | "semantic-delta" | "session-signature" | "sha-pointer" | "escalated-full"
	OriginalTokens  int
	DeliveredTokens int
	SavingsPercent  float64
}

Result is the output of CompressFileRead.

func CompressFileRead

func CompressFileRead(filePath, content string, opts Options) Result

CompressFileRead returns the rendered output and ledger metadata.