FileHandle

readCompletionNotification

static get readCompletionNotification(): NSNotification_Name

class let readCompletionNotification: NSNotification.Name

init

static initForReadingAtPath(path: string): (FileHandle) | null

convenience init?(forReadingAtPath path: String)

init

static initForReadingFrom(url: string): FileHandle

convenience init(forReadingFrom url: URL) throws

init

static initForUpdatingAtPath(path: string): (FileHandle) | null

convenience init?(forUpdatingAtPath path: String)

init

static initForUpdating(url: string): FileHandle

convenience init(forUpdating url: URL) throws

init

static initForWritingAtPath(path: string): (FileHandle) | null

convenience init?(forWritingAtPath path: String)

init

static initForWritingTo(url: string): FileHandle

convenience init(forWritingTo url: URL) throws

nullDevice

static get nullDevice(): FileHandle

class var nullDevice: FileHandle { get }

standardError

static get standardError(): FileHandle

class var standardError: FileHandle { get }

standardInput

static get standardInput(): FileHandle

class var standardInput: FileHandle { get }

standardOutput

static get standardOutput(): FileHandle

class var standardOutput: FileHandle { get }

acceptConnectionInBackgroundAndNotify

acceptConnectionInBackgroundAndNotify(): void

func acceptConnectionInBackgroundAndNotify()

acceptConnectionInBackgroundAndNotify

acceptConnectionInBackgroundAndNotifyForModes(modes?: (Array<RunLoop_Mode>) | null): void

func acceptConnectionInBackgroundAndNotify(forModes modes: [RunLoop.Mode]?)

close

close(): void

func close() throws

closeFile

closeFile(): void

func closeFile()

init

static initCoder(coder: NSCoder): (FileHandle) | null

init?(coder: NSCoder)

init

static initFileDescriptor(fd: number): FileHandle

convenience init(fileDescriptor fd: Int32)

init

static initFileDescriptorCloseOnDealloc(fd: number, closeopt: boolean): FileHandle

init(fileDescriptor fd: Int32, closeOnDealloc closeopt: Bool)

readData

readData(length: number): ArrayBuffer

func readData(ofLength length: Int) -> Data

readDataToEndOfFile

readDataToEndOfFile(): ArrayBuffer

func readDataToEndOfFile() -> Data

readInBackgroundAndNotify

readInBackgroundAndNotify(): void

func readInBackgroundAndNotify()

readInBackgroundAndNotify

readInBackgroundAndNotifyForModes(modes?: (Array<RunLoop_Mode>) | null): void

func readInBackgroundAndNotify(forModes modes: [RunLoop.Mode]?)

readToEndOfFileInBackgroundAndNotify

readToEndOfFileInBackgroundAndNotify(): void

func readToEndOfFileInBackgroundAndNotify()

readToEndOfFileInBackgroundAndNotify

readToEndOfFileInBackgroundAndNotifyForModes(modes?: (Array<RunLoop_Mode>) | null): void

func readToEndOfFileInBackgroundAndNotify(forModes modes: [RunLoop.Mode]?)

seekToEndOfFile

seekToEndOfFile(): number

func seekToEndOfFile() -> UInt64

seek

seekToFileOffset(offset: number): void

func seek(toFileOffset offset: UInt64)

seek

seekToOffset(offset: number): void

func seek(toOffset offset: UInt64) throws

synchronize

synchronize(): void

func synchronize() throws

synchronizeFile

synchronizeFile(): void

func synchronizeFile()

truncate

truncate(offset: number): void

func truncate(atOffset offset: UInt64) throws

truncateFile

truncateFile(offset: number): void

func truncateFile(atOffset offset: UInt64)

waitForDataInBackgroundAndNotify

waitForDataInBackgroundAndNotify(): void

func waitForDataInBackgroundAndNotify()

waitForDataInBackgroundAndNotify

waitForDataInBackgroundAndNotifyForModes(modes?: (Array<RunLoop_Mode>) | null): void

func waitForDataInBackgroundAndNotify(forModes modes: [RunLoop.Mode]?)

write

write(data: ArrayBuffer): void

func write(_ data: Data)

availableData

get availableData(): ArrayBuffer

var availableData: Data { get }

fileDescriptor

get fileDescriptor(): number

var fileDescriptor: Int32 { get }

offsetInFile

get offsetInFile(): number

var offsetInFile: UInt64 { get }

readabilityHandler

get readabilityHandler(): (((arg0: FileHandle) => Promise<void>)) | null

var readabilityHandler: (@Sendable (FileHandle) -> Void)? { get set }

readabilityHandler

set readabilityHandler(value: (((arg0: FileHandle) => void)) | null)

var readabilityHandler: (@Sendable (FileHandle) -> Void)? { get set }

writeabilityHandler

get writeabilityHandler(): (((arg0: FileHandle) => Promise<void>)) | null

var writeabilityHandler: (@Sendable (FileHandle) -> Void)? { get set }

writeabilityHandler

set writeabilityHandler(value: (((arg0: FileHandle) => void)) | null)

var writeabilityHandler: (@Sendable (FileHandle) -> Void)? { get set }

read

read(count: number): (ArrayBuffer) | null

func read(upToCount count: Int) throws -> Data?

Reads data synchronously up to the specified number of bytes. - Parameter count: The number of bytes to read from the file handle. - Returns: The data available through the receiver up to a maximum of `count` bytes, or the maximum size that can be represented by an `NSData` object, whichever is the smaller. If the handle represents a file, this method returns the data obtained by reading `count` bytes starting at the current file pointer. If `count` bytes aren't available, this method returns the data obtained by reading bytes up to the end of the file. If the handle represents a communications channel, this method reads up to `count` bytes from the channel.

bytes

get bytes(): FileHandle_AsyncBytes

var bytes: FileHandle.AsyncBytes { get }

The file's contents, as an asynchronous sequence of bytes. Use the `for`-`await`-`in` syntax to iterate over the bytes in this sequence. For text files, you can also use its `characters`, `unicodeScalars`, or `lines` properties to retrieve the contents in a more convenient format. > Tip: Rather than creating a ``FileHandle`` to read a file asynchronously, you can instead use a `file://` URL in combination with the `URL.resourceBytes` property.

write

writeContentsOf(data: ArrayBuffer): void

func write<T>(contentsOf data: T) throws where T : DataProtocol

Writes the specified data synchronously to the file handle. - Parameter data: The data to write to the file handle. If the handle represents a file, writing takes place at the file pointer's current position. After it writes the data, the method advances the file pointer by the number of bytes written. This method throws an error if the file descriptor is closed or isn't valid, if the handle represents an unconnected pipe or socket endpoint, if there isn't any free space on the file system, or if any other writing error occurs.

offset

offset(): number

func offset() throws -> UInt64

Gets the position of the file pointer within the file. - Returns: The position of the file pointer within the file. Throws an error if called on a file handle representing a pipe or socket, or if the file descriptor is closed.

readToEnd

readToEnd(): (ArrayBuffer) | null

func readToEnd() throws -> Data?

Reads the available data synchronously up to the end of file or maximum number of bytes. - Returns: The data available through the file handle up to the maximum size that can be represented by an `NSData` object or, if a communications channel, until an end-of-file indicator is returned. This method invokes ``readData(ofLength:)`` as part of its implementation.

seekToEnd

seekToEnd(): number

@discardableResult func seekToEnd() throws -> UInt64

Places the file pointer at the end of the file referenced by the file handle and returns the new file offset. - Returns: The file offset with the file pointer at the end of the file. This is therefore equal to the size of the file. Throws an error if called a file handle representing a pipe or socket, or if the file descriptor is closed.