Structureswift-nio 2.84.0_NIOFileSystem
ReadFileHandle
Implements ReadableFileHandleProtocol by making system calls to interact with the local file system.
- iOS
- 13.0+
- macOS
- 10.15+
- tvOS
- 13.0+
- watchOS
- 6.0+
struct ReadFileHandleImplements ReadableFileHandleProtocol by making system calls to interact with the local file system.
struct ReadFileHandleimport _NIOFileSystemA file system library for Swift.
protocol ReadableFileHandleProtocol : FileHandleProtocolA handle for reading data from an open file.
struct FileSystemA file system which interacts with the local system. The file system uses a thread pool to perform system calls.
struct FileHandleImplements FileHandleProtocol by making system calls to interact with the local file system.
protocol FileHandleProtocolA handle for a file system object.
struct WriteFileHandleImplements WritableFileHandleProtocol by making system calls to interact with the local file system.
struct ReadWriteFileHandleImplements ReadableAndWritableFileHandleProtocol by making system calls to interact with the local file system.
struct DirectoryFileHandleImplements 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 : FileHandleProtocolProvides a FileHandle.
let fileHandle: FileHandlefunc readChunk(fromAbsoluteOffset offset: Int64, length: ByteCount) async throws -> ByteBuffer func readChunks(in range: Range<Int64>, chunkLength: ByteCount) -> FileChunks func setTimes(lastAccess: FileInfo.Timespec?, lastDataModification: FileInfo.Timespec?) async throws func addPermissions(_ permissions: FilePermissions) async throws -> FilePermissions func attributeNames() async throws -> [String] func bufferedReader(startingAtAbsoluteOffset initialOffset: Int64 = 0, capacity: ByteCount = .kibibytes(512)) -> BufferedReader<Self> Creates a new BufferedReader for this file handle.
func close() async throws func detachUnsafeFileDescriptor() throws -> FileDescriptor func info() async throws -> FileInfo func readChunks(chunkLength: ByteCount = .kibibytes(128)) -> FileChunks Returns an asynchronous sequence of chunks read from the file.
func readToEnd(fromAbsoluteOffset offset: Int64 = 0, maximumSizeAllowed: ByteCount) async throws -> ByteBuffer Returns the contents of a file by loading it into memory.
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 RandomAccessCollection<UInt8> & Sendable, attribute name: String) async throws func valueForAttribute(_ name: String) async throws -> [UInt8] func withUnsafeDescriptor<R>(_ execute: @escaping (FileDescriptor) throws -> R) async throws -> R where R : Sendable