Required Instance Methodswift-nio 2.72.0_NIOFileSystem
replaceItem(at:withItemAt:)
Replaces the item at destinationPath with the item at existingPath.
- iOS
- 13.0+
- macOS
- 10.15+
- tvOS
- 13.0+
- watchOS
- 6.0+
func replaceItem(at destinationPath: FilePath, withItemAt existingPath: FilePath) async throws Parameters
- destinationPath
The path of the file or directory to replace.
- existingPath
The path of the existing file or directory.
The following error codes may be thrown:
notFoundif the item atexistingPathdoes not exist,ioif the file atexistingPathwas successfully copied todestinationPathbut an error occurred while removing it fromexistingPath.
Note that other errors may also be thrown.
The item at destinationPath is not required to exist. Note that it is possible to replace a file with a directory and vice versa. After the file or directory at destinationPath has been replaced, the item at existingPath will be removed.
See also
func copyItem(at: FilePath, to: 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.
func removeItem(at: FilePath) async throws -> Int Deletes the file or directory (and its contents) at
path.func moveItem(at: FilePath, to: FilePath) async throws Moves the file or directory at the specified path to a new location.
func createDirectory(at: FilePath, withIntermediateDirectories: Bool, permissions: FilePermissions?) async throws Create a directory at the given path.
Other requirements
Type members
associatedtype DirectoryFileHandleThe type of
DirectoryFileHandleProtocolto return when opening directories.associatedtype ReadFileHandleThe type of
ReadableFileHandleProtocolto return when opening files for reading.associatedtype ReadWriteFileHandleThe type of
ReadableAndWritableFileHandleProtocolto return when opening files for reading and writing.associatedtype WriteFileHandleThe type of
WritableFileHandleProtocolto return when opening files for writing.
Instance members
var currentWorkingDirectory: FilePathReturns the current working directory.
var temporaryDirectory: FilePathReturns the path of the 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 Copies the item at the specified path to a new location.
func createSymbolicLink(at: FilePath, withDestination: FilePath) async throws Creates a symbolic link that points to the destination.
func createTemporaryDirectory(template: FilePath) async throws -> FilePath Create a temporary directory at the given path, from 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 the given path, if it exists; nil otherwise.
func openDirectory(atPath: FilePath, options: OpenOptions.Directory) async throws -> DirectoryFileHandle Opens the directory at
pathand returns a handle to it.func openFile(forReadingAndWritingAt: FilePath, options: OpenOptions.Write) async throws -> ReadWriteFileHandle Opens the file at
pathfor reading and writing and returns a handle to it.func openFile(forReadingAt: FilePath, options: OpenOptions.Read) async throws -> ReadFileHandle Opens the file at
pathfor reading and returns a handle to it.func openFile(forWritingAt: FilePath, options: OpenOptions.Write) async throws -> WriteFileHandle Opens the file at
pathfor writing and returns a handle to it.func removeItem(at: FilePath, recursively: Bool) async throws -> Int Deletes the file or directory (and its contents) at
path.