docs

api/utils/accessio/chunkedreader.go

@@ -8,6 +8,12 @@ import (
 	"github.com/mandelsoft/goutils/general"
 )
 
+// ChunkedReader splits a reader into several
+// logical readers with a limited content size.
+// Once the reader reaches its limits it provides
+// a io.EOF.
+// It can be continued by Calling Next, which returns
+// whether a follow-up is required or not.
 type ChunkedReader struct {
 	lock   sync.Mutex
 	reader io.Reader
@@ -34,7 +40,7 @@ func (c *ChunkedReader) Read(p []byte) (n int, err error) {
 	c.lock.Lock()
 	defer c.lock.Unlock()
 
-	if c.read == c.size {
+	if c.read >= c.size {
 		return 0, io.EOF
 	}
 	if c.read+int64(len(p)) > c.size {

api/utils/accessio/chunkedreader_test.go

@@ -6,10 +6,11 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+
 	"ocm.software/ocm/api/utils/accessio"
 )
 
-var _ = FDescribe("Test Environment", func() {
+var _ = Describe("Test Environment", func() {
 	in := "12345678901234567890"
 	var buf *bytes.Buffer
 	var chunked *accessio.ChunkedReader

api/utils/blobaccess/chunked/access.go

@@ -14,7 +14,7 @@ import (
 	"ocm.software/ocm/api/utils/mime"
 )
 
-func newChunck(r io.Reader, fss ...vfs.FileSystem) (bpi.BlobAccess, error) {
+func newChunk(r io.Reader, fss ...vfs.FileSystem) (bpi.BlobAccess, error) {
 	t, err := blobaccess.NewTempFile("", "chunk-*", fss...)
 	if err != nil {
 		return nil, err
@@ -28,6 +28,8 @@ func newChunck(r io.Reader, fss ...vfs.FileSystem) (bpi.BlobAccess, error) {
 	return t.AsBlob(mime.MIME_OCTET), nil
 }
 
+// ChunkedBlobSource provides a sequence of
+// bpi.BlobAccess objects.
 type ChunkedBlobSource interface {
 	Next() (bpi.BlobAccess, error)
 }
@@ -40,6 +42,12 @@ type chunkedAccess struct {
 	cont      bool
 }
 
+// New provides a sequence of
+// bpi.BlobAccess objects for a given io.Reader
+// each with a limited size.
+// The provided blobs are temporarily stored
+// on the filesystem and can therefore be kept
+// and accessed any number of times until they are closed.
 func New(r io.Reader, chunksize int64, fss ...vfs.FileSystem) ChunkedBlobSource {
 	reader := accessio.NewChunkedReader(r, chunksize)
 	return &chunkedAccess{
@@ -63,5 +71,5 @@ func (r *chunkedAccess) Next() (bpi.BlobAccess, error) {
 		}
 	}
 	r.cont = true
-	return newChunck(r.reader, r.fs)
+	return newChunk(r.reader, r.fs)
 }