package saferio

Import Path
	internal/saferio (on go.dev)

Dependency Relation
	imports 2 packages, and imported by 8 packages

Involved Source Files

	  d io.go
		Package saferio provides I/O functions that avoid allocating large
		amounts of memory unnecessarily. This is intended for packages that
		read data from an [io.Reader] where the size is part of the input
		data but the input may be corrupt, or may be provided by an
		untrustworthy attacker.
Package-Level Functions (total 4)

	 func ReadData(r io.Reader, n uint64) ([]byte, error)
		ReadData reads n bytes from the input stream, but avoids allocating
		all n bytes if n is large. This avoids crashing the program by
		allocating all n bytes in cases where n is incorrect.
		
		The error is io.EOF only if no bytes were read.
		If an io.EOF happens after reading some but not all the bytes,
		ReadData returns io.ErrUnexpectedEOF.

	 func ReadDataAt(r io.ReaderAt, n uint64, off int64) ([]byte, error)
		ReadDataAt reads n bytes from the input stream at off, but avoids
		allocating all n bytes if n is large. This avoids crashing the program
		by allocating all n bytes in cases where n is incorrect.

	 func SliceCap[E](c uint64) int

		Type Parameters:
			E: any

		SliceCap is like SliceCapWithSize but using generics.

	 func SliceCapWithSize(size, c uint64) int
		SliceCapWithSize returns the capacity to use when allocating a slice.
		After the slice is allocated with the capacity, it should be
		built using append. This will avoid allocating too much memory
		if the capacity is large and incorrect.
		
		A negative result means that the value is always too big.

The pages are generated with Golds v0.7.0-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.