Instance MethodSystemPackage

    read(into:retryOnInterrupt:)

    Reads bytes at the current file offset into a buffer.

    func read(into buffer: UnsafeMutableRawBufferPointer, retryOnInterrupt: Bool = true) throws -> Int

    Parameters

    buffer

    The region of memory to read into.

    retryOnInterrupt

    Whether to retry the read operation if it throws Errno.interrupted. The default is true. Pass false to try only once and throw an error upon interruption.

    Returns

    The number of bytes that were read.

    Overview

    The doc://com.apple.documentation/documentation/swift/unsafemutablerawbufferpointer/3019191-count 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.