Writing and Appending to Files in Swift

Welcome to the lesson on writing to files in Swift. As a programmer, the ability to save data to a file is essential for tasks such as logging information, saving user data, and generating reports. This lesson focuses on the fundamentals of writing text to files using Swift's file handling capabilities, which are important skills for managing data in real-world applications. By the end of this lesson, you'll be equipped with the knowledge to write and append content to files using Swift’s write(to:options:) method and FileHandle.

To begin writing to a file in Swift, we'll use the write(to:options:) method from the Data class. Let's explore how this is done step by step:

1. Specify the Output File Path: Begin by defining the file path where your data will be stored. We'll use Swift's URL for this purpose.

   Swift

   let outputFilePath = URL(fileURLWithPath: "output.txt")

2. Convert String to Data and Write to the File: Convert the string content to data and write it to the file using the write(to:options:) method. This method takes the file URL and write options as arguments. Here, we'll use .atomic to ensure the write operation is completed successfully before replacing the existing file. This prevents corruption in case of a power failure or crash during writing. Swift first writes the data to a temporary file and only replaces the original file after a successful write.

   Swift

   let content = "Hello, World!\nThis is a new line of text.\n"
   do {
       try content.data(using: .utf8)?.write(to: outputFilePath, options: .atomic)
   } catch {
       print("Failed to write to file: \(error)")
   }

When executed, this sequence of operations will create a file named output.txt (if it doesn't exist) and write the specified lines of text into it. The content will be overwritten if the file exists.

The content of the file after executing write(to:options:) will look like this:

Hello, World!
This is a new line of text.

Sometimes, you may want to add data to an existing file without overwriting its current contents. This can be achieved in Swift using FileHandle.

The FileHandle class allows you to append new content to the end of an existing file. Here’s how you can do it:

do {
    let fileHandle = try FileHandle(forWritingTo: outputFilePath)
    defer {
        fileHandle.closeFile()
    }
    
    if let data = "Appending another line of text.\n".data(using: .utf8) {
        fileHandle.seekToEndOfFile()
        fileHandle.write(data)
    }
} catch {
    print("Failed to append to file: \(error)")
}

When the append operation completes, the new line is added to the end of the existing file content. Following the append operation, the final content of the file will be:

Hello, World!
This is a new line of text.
Appending another line of text.