aboutsummaryrefslogtreecommitdiff
path: root/objectstore/loose/read_header.go
diff options
context:
space:
mode:
Diffstat (limited to 'objectstore/loose/read_header.go')
-rw-r--r--objectstore/loose/read_header.go4
1 files changed, 4 insertions, 0 deletions
diff --git a/objectstore/loose/read_header.go b/objectstore/loose/read_header.go
index 494acfc4..0cd3273d 100644
--- a/objectstore/loose/read_header.go
+++ b/objectstore/loose/read_header.go
@@ -9,6 +9,10 @@ import (
)
// ReadHeader reads an object's type and declared content length.
+//
+// It parses only enough of the zlib-decoded object to recover the object
+// header. It does not verify that the remaining object content is readable and
+// does not verify the zlib Adler-32 trailer.
func (store *Store) ReadHeader(id objectid.ObjectID) (objecttype.Type, int64, error) {
file, err := store.openObject(id)
if err != nil {