aboutsummaryrefslogtreecommitdiff
path: root/objectstore/packed/read_header.go
diff options
context:
space:
mode:
authorGravatar Runxi Yu2026-03-22 17:33:27 +0000
committerGravatar Runxi Yu2026-03-22 17:33:27 +0000
commitd314d1f7e933ca83081eec289aa0cb6e75a7eeac (patch)
treeacd567019d1253d23bcebf6fe8ab9df54d24d3d0 /objectstore/packed/read_header.go
parentobjectstore{,/loose}: Document contracts more clearly (diff)
signatureNo signature
objectstore{,/packed}: Document lifetime and integrity behavior
Diffstat (limited to 'objectstore/packed/read_header.go')
-rw-r--r--objectstore/packed/read_header.go4
1 files changed, 4 insertions, 0 deletions
diff --git a/objectstore/packed/read_header.go b/objectstore/packed/read_header.go
index 5eb37c92..5070c98b 100644
--- a/objectstore/packed/read_header.go
+++ b/objectstore/packed/read_header.go
@@ -6,6 +6,10 @@ import (
)
// ReadHeader reads an object's type and declared content size.
+//
+// It resolves header metadata only. It does not verify that the full pack entry
+// payload is readable and does not verify any zlib Adler-32 trailer for
+// compressed entry data.
func (store *Store) ReadHeader(id objectid.ObjectID) (objecttype.Type, int64, error) {
loc, err := store.lookup(id)
if err != nil {