summaryrefslogtreecommitdiff
path: root/lib/btrfs/btrfsitem/items.go
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@lukeshu.com>2023-03-17 18:38:14 -0400
committerLuke Shumaker <lukeshu@lukeshu.com>2023-03-17 18:38:14 -0400
commit0f85e72d1331b49b52925d6cc5ad083a0376104c (patch)
tree9ba66e893d6f66096f6b06284d09c8eb3e50facc /lib/btrfs/btrfsitem/items.go
parentc0f33186aa7a8903c5e7406024f13fad48cd14e3 (diff)
parent1ea26f04701fa66e36b058f3efb3a6c7059cdc5c (diff)
Merge branch 'lukeshu/lint'
Diffstat (limited to 'lib/btrfs/btrfsitem/items.go')
-rw-r--r--lib/btrfs/btrfsitem/items.go8
1 files changed, 7 insertions, 1 deletions
diff --git a/lib/btrfs/btrfsitem/items.go b/lib/btrfs/btrfsitem/items.go
index 49d421f..a730447 100644
--- a/lib/btrfs/btrfsitem/items.go
+++ b/lib/btrfs/btrfsitem/items.go
@@ -2,6 +2,8 @@
//
// SPDX-License-Identifier: GPL-2.0-or-later
+// Package btrfsitem contains the definitions of all "items" that may
+// be stored in a btrfs tree.
package btrfsitem
import (
@@ -56,7 +58,11 @@ func (o *Error) UnmarshalBinary(dat []byte) (int, error) {
return len(dat), nil
}
-// Rather than returning a separate error value, return an Error item.
+// UnmarshalItem consumes the byte slice `dat`, unmarshaling it in to
+// the item type specified by `key`.
+//
+// If there is an error, rather than returning a separate error value,
+// return an Error item.
func UnmarshalItem(key btrfsprim.Key, csumType btrfssum.CSumType, dat []byte) Item {
var gotyp reflect.Type
if key.ItemType == UNTYPED_KEY {