WriteFileHandle
Implements WritableFileHandleProtocol
by making system calls to interact with the local file system.
- iOS
- 13.0+
- macOS
- 10.15+
- tvOS
- 13.0+
- watchOS
- 6.0+
struct WriteFileHandle
Implements WritableFileHandleProtocol
by making system calls to interact with the local file system.
struct WriteFileHandle
import _NIOFileSystem
A file system library for Swift.
protocol WritableFileHandleProtocol : FileHandleProtocol
A file handle suitable for writing.
struct FileSystem
A file system which interacts with the local system. The file system uses a thread pool to perform system calls.
struct FileHandle
Implements FileHandleProtocol
by making system calls to interact with the local file system.
protocol FileHandleProtocol
A handle for a file system object.
struct ReadFileHandle
Implements ReadableFileHandleProtocol
by making system calls to interact with the local file system.
struct ReadWriteFileHandle
Implements ReadableAndWritableFileHandleProtocol
by making system calls to interact with the local file system.
struct DirectoryFileHandle
Implements DirectoryFileHandleProtocol
by making system calls to interact with the local file system.
func withFileSystem<Result>(numberOfThreads: Int, _ body: (FileSystem) async throws -> Result) async throws -> Result
Provides temporary scoped access to a FileSystem
with the given number of threads.
protocol _HasFileHandle : FileHandleProtocol
Provides a FileHandle
.
let fileHandle: FileHandle
func close(makeChangesVisible: Bool) async throws
func resize(to size: ByteCount) async throws
func setTimes(lastAccess: FileInfo.Timespec?, lastDataModification: FileInfo.Timespec?) async throws
@discardableResult func write(contentsOf bytes: some (Sequence<UInt8> & Sendable), toAbsoluteOffset offset: Int64) async throws -> Int64
func addPermissions(_ permissions: FilePermissions) async throws -> FilePermissions
func attributeNames() async throws -> [String]
func bufferedWriter(startingAtAbsoluteOffset initialOffset: Int64 = 0, capacity: ByteCount = .kibibytes(512)) -> BufferedWriter<Self>
Creates a new BufferedWriter
for this file handle.
func close() async throws
func detachUnsafeFileDescriptor() throws -> FileDescriptor
func info() async throws -> FileInfo
func removePermissions(_ permissions: FilePermissions) async throws -> FilePermissions
func removeValueForAttribute(_ name: String) async throws
func replacePermissions(_ permissions: FilePermissions) async throws
func setLastAccessTime(to time: FileInfo.Timespec) async throws
Sets the file’s last access time to the given time.
func setLastDataModificationTime(to time: FileInfo.Timespec) async throws
Sets the file’s last data modification time to the given time.
func synchronize() async throws
func touch() async throws
Sets the file’s last access and last data modification times to the current time.
func updateValueForAttribute(_ bytes: some (Sendable & RandomAccessCollection<UInt8>), attribute name: String) async throws
func valueForAttribute(_ name: String) async throws -> [UInt8]
func withBufferedWriter<Result>(startingAtAbsoluteOffset initialOffset: Int64 = 0, capacity: ByteCount = .kibibytes(512), execute body: (inout BufferedWriter<Self>) async throws -> Result) async throws -> Result
Convenience function that creates a buffered reader, executes the closure that writes the contents into the buffer and calls ‘flush()’.
func withUnsafeDescriptor<R>(_ execute: @escaping (FileDescriptor) throws -> R) async throws -> R where R : Sendable
@discardableResult func write(contentsOf buffer: ByteBuffer, toAbsoluteOffset offset: Int64) async throws -> Int64
Write the readable bytes of the ByteBuffer
to the open file.