Fast implementation of Git in pure Go
codeberg.org/lindenii/furgit
git
go
format/packfile/ingest: Update docs
+6
-2
+6
-2
format/packfile/ingest/api.go
+6
-2
format/packfile/ingest/api.go
···
70
70
// Pending is one started ingest operation awaiting Continue or Discard.
71
71
//
72
72
// Exactly one of Continue or Discard may be called.
73
+
//
74
+
// Labels: MT-Unsafe.
73
75
type Pending struct {
74
76
reader *bufio.Reader
75
77
algo objectid.Algorithm
···
81
83
}
82
84
83
85
// Ingest reads and validates one PACK header, returning one pending operation.
86
+
//
87
+
// Labels: Deps-Borrowed.
84
88
func Ingest(
85
89
src io.Reader,
86
90
algo objectid.Algorithm,
···
113
117
114
118
// Continue ingests the pack stream into destination and writes pack artifacts.
115
119
//
116
-
// Continue is terminal. Further use of pending is undefined behavior.
120
+
// Continue invalidates the receiver.
117
121
//
118
122
// Artifacts are published under content-addressed final names derived from the
119
123
// resulting pack hash. If those final names already exist, Continue treats that
···
143
147
// Discard consumes and verifies one zero-object pack stream without writing
144
148
// files.
145
149
//
146
-
// Discard is terminal. Further use of pending is undefined behavior.
150
+
// Discard invalidates the receiver.
147
151
func (pending *Pending) Discard() (DiscardResult, error) {
148
152
pending.finalized = true
149
153