Open the file at path for reading.
func openFile(forReadingAt path: FilePath, options: OpenOptions.Read) async throws -> ReadFileHandle s14_NIOFileSystem04FileB0V04openC012forReadingAt7optionsAA04ReadC6HandleV0B7Package0C4PathV_AA11OpenOptionsO0I0VtYaKF What are these?3N66SA readable handle to the opened file.
Error codes thrown include:
notFound if path doesn’t exist.
Uses the open(2) system call.
import _NIOFileSystemA file system library for Swift.
struct FileSystemA file system which interacts with the local system. The file system uses a thread pool to perform system calls.
struct FilePathRepresents a location in the file system.
enum OpenOptionsOptions for opening file handles.
struct ReadOptions for opening a file for reading.
struct ReadFileHandleImplements ReadableFileHandleProtocol by making system calls to interact with the local file system.
static var notFound: Self { get }The file could not be found.
init(threadPool: NIOThreadPool) Creates a new FileSystem using the provided thread pool.
static var shared: FileSystem { get }Returns a shared global instance of the FileSystem.
var currentWorkingDirectory: FilePath { get async throws }Returns the path of the current working directory.
var temporaryDirectory: FilePath { get async throws }Returns a path to a temporary directory.
func copyItem(at sourcePath: FilePath, to destinationPath: FilePath, strategy copyStrategy: CopyStrategy, shouldProceedAfterError: @escaping (_ source: DirectoryEntry, _ error: Error) async throws -> Void, shouldCopyItem: @escaping (_ source: DirectoryEntry, _ destination: FilePath) async -> Bool) async throws See copyItem(at:to:shouldProceedAfterError:shouldCopyFile:)
func createDirectory(at path: FilePath, withIntermediateDirectories createIntermediateDirectories: Bool, permissions: FilePermissions?) async throws Create a directory at the given path.
func createSymbolicLink(at linkPath: FilePath, withDestination destinationPath: FilePath) async throws Creates a symbolic link between two files.
func createTemporaryDirectory(template: FilePath) async throws -> FilePath Create a temporary directory at the given path, using a template.
func destinationOfSymbolicLink(at path: FilePath) async throws -> FilePath Returns the path of the item pointed to by a symbolic link.
func info(forFileAt path: FilePath, infoAboutSymbolicLink: Bool) async throws -> FileInfo? Returns information about the file at path if it exists; nil otherwise.
func moveItem(at sourcePath: FilePath, to destinationPath: FilePath) async throws Moves the named file or directory to a new location.
func openDirectory(atPath path: FilePath, options: OpenOptions.Directory) async throws -> DirectoryFileHandle Open the directory at path.
func openFile(forReadingAndWritingAt path: FilePath, options: OpenOptions.Write) async throws -> ReadWriteFileHandle Open the file at path for reading and writing.
func openFile(forWritingAt path: FilePath, options: OpenOptions.Write) async throws -> WriteFileHandle Open the file at path for writing.
@discardableResult func removeItem(at path: FilePath, strategy removalStrategy: RemovalStrategy, recursively removeItemRecursively: Bool) async throws -> Int See removeItem(at:strategy:recursively:)
func removeOneItem(at path: FilePath, function: String = #function, file: String = #fileID, line: Int = #line) async throws -> Int func replaceItem(at destinationPath: FilePath, withItemAt existingPath: FilePath) async throws Replaces the item at destinationPath with the item at existingPath.
func copyItem(at sourcePath: FilePath, to destinationPath: FilePath, shouldProceedAfterError: @escaping (_ entry: DirectoryEntry, _ error: Error) async throws -> Void, shouldCopyFile: @escaping (_ source: FilePath, _ destination: FilePath) async -> Bool) async throws Copies the item at the specified path to a new location.