aboutsummaryrefslogtreecommitdiff
path: root/object/stored/stored.go
blob: 4429a373e9cb722e34e5b83fdca193f8148689f0 (about) (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// Package stored wraps parsed objects with their storage object IDs.
//
// Stored values are typically instantiated with pointer object types such as
// *blob.Blob, *tree.Tree, *commit.Commit, or *tag.Tag, because those
// pointer types satisfy object.Object.
package stored

import (
	"codeberg.org/lindenii/furgit/object"
	objectid "codeberg.org/lindenii/furgit/object/id"
)

// Stored represents a stored object,
// i.e., an object along with its object ID.
type Stored[T object.Object] struct {
	id  objectid.ObjectID
	obj T
}

// New creates one stored object wrapper.
func New[T object.Object](id objectid.ObjectID, obj T) *Stored[T] {
	return &Stored[T]{id: id, obj: obj}
}

// ID returns the object ID.
func (stored *Stored[T]) ID() objectid.ObjectID {
	return stored.id
}

// Object returns the wrapped object as itself.
func (stored *Stored[T]) Object() T {
	return stored.obj
}