docs: add explaination for the limit check

NordSecurity · Dec 13, 2024 · df8d4a0 · df8d4a0
1 parent 72ad505
commit df8d4a0
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/core/core.go b/core/core.go
@@ -588,6 +588,11 @@ func MaxBytesReadAll(r io.Reader) ([]byte, error) {
 	if err != nil {
 		return nil, err
 	}
+	// check whether the io.ReadAll() stopped because of EOF coming from io.Reader or because of the limit
+	//
+	// two cases can happen here:
+	// limit reached       - limitedReader.N <= 0
+	// io.Reader is empty  - limitedReader.N > 0
 	if limitedReader.N <= 0 {
 		return nil, &ErrMaxBytesLimit{Limit: maxBytesLimit}
 	}