diff options
| author |  Runxi Yu | 2026-03-22 17:27:37 +0000 |
|---|---|---|
| committer | Runxi Yu | 2026-03-22 17:27:37 +0000 |
| commit | 8f577284f47f699855dcb3ceda21aa9d8be77c2f (patch) | |
| tree | 36f8d47a1584bd80e9e114d5c68ad5ec6c333b88 /objectstore/loose/read_header.go | |
| parent | internal/testgit: why not make it more annoying to use ambient authority (diff) | |
| signature | No signature | |
objectstore{,/loose}: Document contracts more clearly
Diffstat (limited to 'objectstore/loose/read_header.go')
| -rw-r--r-- | objectstore/loose/read_header.go | 4 |
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 { |