Required Instance Methodswift-nio 2.72.0_NIOFileSystem
moveItem(at:to:)
Moves the file or directory at the specified path to a new location.
FileSystemProtocol.swift:282- iOS
- 13.0+
- macOS
- 10.15+
- tvOS
- 13.0+
- watchOS
- 6.0+
func moveItem(at sourcePath: FilePath, to destinationPath: FilePath) async throws
Parameters
- sourcePath
The path to the item to move.
- destinationPath
The path at which to place the item.
The following error codes may be thrown:
notFound
if the item atsourcePath
does not exist,invalidArgument
if an item atdestinationPath
exists prior to the copy or its parent directory does not exist.
Note that other errors may also be thrown.
If the file at sourcePath
is a symbolic link then only the link is moved to the new path.
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 replaceItem(at: FilePath, withItemAt: FilePath
) async throws Replaces the item at
destinationPath
with the item atexistingPath
.func createDirectory(at: FilePath, withIntermediateDirectories: Bool, permissions: FilePermissions?
) async throws Create a directory at the given path.
Other requirements
Type members
associatedtype DirectoryFileHandle
The type of
DirectoryFileHandleProtocol
to return when opening directories.associatedtype ReadFileHandle
The type of
ReadableFileHandleProtocol
to return when opening files for reading.associatedtype ReadWriteFileHandle
The type of
ReadableAndWritableFileHandleProtocol
to return when opening files for reading and writing.associatedtype WriteFileHandle
The type of
WritableFileHandleProtocol
to return when opening files for writing.
Instance members
var currentWorkingDirectory: FilePath
Returns the current working directory.
var temporaryDirectory: FilePath
Returns 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
path
and returns a handle to it.func openFile(forReadingAndWritingAt: FilePath, options: OpenOptions.Write
) async throws -> ReadWriteFileHandle Opens the file at
path
for reading and writing and returns a handle to it.func openFile(forReadingAt: FilePath, options: OpenOptions.Read
) async throws -> ReadFileHandle Opens the file at
path
for reading and returns a handle to it.func openFile(forWritingAt: FilePath, options: OpenOptions.Write
) async throws -> WriteFileHandle Opens the file at
path
for 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
.