read(into:retryOnInterrupt:)
Reads bytes at the current file offset into a buffer.
Declaration
func read(into buffer: UnsafeMutableRawBufferPointer, retryOnInterrupt: Bool = true) throws -> IntParameters
- buffer:
The region of memory to read into.
- retryOnInterrupt:
Whether to retry the read operation if it throws Interrupted. The default is
true. Passfalseto try only once and throw an error upon interruption.
Mentioned in
Return Value
The number of bytes that were read.
Discussion
The doc://com.apple.documentation/documentation/swift/unsafemutablerawbufferpointer/count-95usp property of buffer determines the maximum number of bytes that are read into that buffer.
After reading, this method increments the file’s offset by the number of bytes read. To change the file’s offset, call the seek(offset:from:) method.
The corresponding C function is read.