Instance Methodswift-nio 2.72.0_NIOFileSystem
createSymbolicLink(at:withDestination:)
Creates a symbolic link between two files.
FileSystem.swift:553- iOS
- 13.0+
- macOS
- 10.15+
- tvOS
- 13.0+
- watchOS
- 6.0+
func createSymbolicLink(at linkPath: FilePath, withDestination destinationPath: FilePath) async throws
Parameters
- path
The path at which to create the symbolic link.
- destinationPath
The path that contains the item that the symbolic link points to.`
A link is created at linkPath
which points to destinationPath
. The destination of a symbolic link can be read with destinationOfSymbolicLink(at:)
.
Errors
Error codes thrown include:
fileAlreadyExists
if a file exists atdestinationPath
.
Implementation details
Uses the link(2)
system call.
Other members in extension
Type members
init(threadPool: NIOThreadPool
) Creates a new
FileSystem
using the provided thread pool.
Instance members
var currentWorkingDirectory: FilePath
Returns the path of the current working directory.
var temporaryDirectory: FilePath
Returns a path to a temporary directory.
func copyItem(at: FilePath, to: FilePath, strategy: CopyStrategy, shouldProceedAfterError: @escaping (_ source: DirectoryEntry, _ error: Error) async throws -> Void, shouldCopyItem: @escaping (_ source: DirectoryEntry, _ destination: FilePath) async -> Bool
) async throws func createDirectory(at: FilePath, withIntermediateDirectories: Bool, permissions: FilePermissions?
) async throws Create a directory at the given path.
func createTemporaryDirectory(template: FilePath
) async throws -> FilePath Create a temporary directory at the given path, using a template.
func destinationOfSymbolicLink(at: FilePath
) async throws -> FilePath Returns the path of the item pointed to by a symbolic link.
func info(forFileAt: FilePath, infoAboutSymbolicLink: Bool
) async throws -> FileInfo? Returns information about the file at
path
if it exists; nil otherwise.func moveItem(at: FilePath, to: FilePath
) async throws Moves the named file or directory to a new location.
func openDirectory(atPath: FilePath, options: OpenOptions.Directory
) async throws -> DirectoryFileHandle Open the directory at
path
.func openFile(forReadingAndWritingAt: FilePath, options: OpenOptions.Write
) async throws -> ReadWriteFileHandle Open the file at
path
for reading and writing.func openFile(forReadingAt: FilePath, options: OpenOptions.Read
) async throws -> ReadFileHandle Open the file at
path
for reading.func openFile(forWritingAt: FilePath, options: OpenOptions.Write
) async throws -> WriteFileHandle Open the file at
path
for writing.func removeItem(at: FilePath, recursively: Bool
) async throws -> Int Deletes the file or directory (and its contents) at
path
.func replaceItem(at: FilePath, withItemAt: FilePath
) async throws Replaces the item at
destinationPath
with the item atexistingPath
.