SwiftIO

SwiftIO is a library that aims to provide similar functionality to the System.IO namespace in .NET for developers transitioning from .NET to Swift. It offers interfaces such as BinaryPrimitives, FileStream, MemoryStream, Binary Reader/Writer, and Encoding, allowing developers to work with IO operations in a familiar way.

The main purpose of SwiftIO is to ease the transition for developers familiar with System.IO in .NET. By providing similar interfaces and functionality, SwiftIO allows developers to leverage their existing knowledge and easily adapt to IO operations in Swift.

• BinaryPrimitives: Provides methods for reading and writing basic data types in binary form, similar to the BinaryPrimitives class in .NET.
• FileStream: Allows reading from and writing to files using familiar stream-based operations.
• MemoryStream: Enables in-memory stream operations for reading from and writing to byte arrays.
• Binary Reader/Writer: Provides functionality for reading and writing binary data, similar to the BinaryReader and BinaryWriter classes in .NET.
• Encoding: Offers encoding and decoding capabilities for various character encodings, facilitating text-based IO operations.

Please note that the IO implementation in this repository focuses on providing usage patterns similar to System.IO, rather than optimizing for IO performance. Users are advised to evaluate their specific requirements and decide whether to utilize this library accordingly.

To use SwiftIO in your Swift project, follow these steps:

1. Clone the repository:

   git clone https://github.com/LITTOMA/SwiftIO.git

2. Add the SwiftIO files to your project.

3. Import the SwiftIO module in your Swift file:

   import SwiftIO

4. You're ready to start using the provided IO interfaces and classes in your code.

Here are a few examples to demonstrate how to use SwiftIO:

The BinaryPrimitives interface in SwiftIO provides methods for reading and writing basic data types in binary form. Let's take a look at a couple of test cases as examples:

Reading a double value in big-endian format:

import SwiftIO

let bytes: [UInt8] = [0x3F, 0xF0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]
let data = Data(bytes)
let value = BinaryPrimitives.readDoubleBigEndian(from: data)
print(value) // Output: 1.0

In this example, we have a byte array representing a double value in big-endian format. We convert it to a Data object and use the readDoubleBigEndian method from BinaryPrimitives to read the value. The resulting value will be 1.0.

Reading a double value in little-endian format:

import SwiftIO

let bytes: [UInt8] = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xF0, 0x3F]
let data = Data(bytes)
let value = BinaryPrimitives.readDoubleLittleEndian(from: data)
print(value) // Output: 1.0

Similarly, in this example, we have a byte array representing a double value in little-endian format. We convert it to a Data object and use the readDoubleLittleEndian method from BinaryPrimitives to read the value. The resulting value will also be 1.0.

The BinaryReader class in SwiftIO provides functionality for reading binary data. Let's take a look at a couple of test cases as examples:

Reading Int16 values in big-endian format:

import SwiftIO

let stream = MemoryStream(bytes: [0x01, 0x02, 0x03, 0x04, 0xFF, 0xFF])
let reader = BinaryReader(stream)
let value1 = reader.readInt16()
let value2 = reader.readInt16()
let value3 = reader.readInt16()

print(value1) // Output: 513
print(value2) // Output: 1027
print(value3) // Output: -1

In this example, we create a MemoryStream object with a byte array containing the binary data. We then create a BinaryReader instance with the stream. We use the readInt16 method of the reader to read three Int16 values from the stream. The resulting values will be printed as output.

Reading Int16 values in little-endian format:

import SwiftIO

let stream = MemoryStream(bytes: [0x01, 0x02, 0x03, 0x04, 0xFF, 0xFF])
let reader = BinaryReader(stream, endianess: .little)
let value1 = reader.readInt16()
let value2 = reader.readInt16()
let value3 = reader.readInt16()

print(value1) // Output: 258
print(value2) // Output: 772
print(value3) // Output: -1

Similarly, in this example, we create a MemoryStream object with a byte array containing the binary data. We then create a BinaryReader instance with the stream, specifying the little-endian format. We use the readInt16 method of the reader to read three Int16 values from the stream in little-endian format. The resulting values will be printed as output.

Please note that in your actual code, you may need to import the SwiftIO module and adapt the test cases based on your specific requirements.

For more detailed examples and usage instructions, please refer to the documentation.

Contributions to SwiftIO are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. Make sure to follow the contribution guidelines when contributing.

This project is licensed under the MIT License.

We hope SwiftIO helps simplify your transition from .NET to Swift and provides a familiar IO experience. If you have any questions or need further assistance, please feel free to reach out to us.

Happy coding!