Close Menu

simplefutures


About SimpleFutures

SimpleFutures is a lightweight library that provides a simple and intuitive way to work with asynchronous and concurrent operations in Swift. By using futures and promises, SimpleFutures enables you to write cleaner, more readable code that is easier to reason about.


Key Features

  • Asynchronous Execution: SimpleFutures allows you to execute operations asynchronously, improving the responsiveness of your applications.
  • Futures and Promises: With SimpleFutures, you can leverage futures and promises to represent the results of asynchronous operations and handle their completion.
  • Chainable Operations: SimpleFutures provides a functional-style interface that allows you to chain multiple operations together, improving code readability and maintainability.
  • Error Handling: The library offers robust error handling capabilities, allowing you to handle errors in a structured manner.
  • Completion Callbacks: SimpleFutures makes it easy to add completion callbacks to your asynchronous operations, providing a mechanism to execute code when an operation finishes.


Installation

To use SimpleFutures in your Swift project, you can either manually add the library to your project or use a dependency manager such as Cocoapods or Carthage.

Manual Installation

  1. Download the SimpleFutures library from the official GitHub repository: https://github.com/simplefutures/SimpleFutures
  2. Drag and drop the SimpleFutures.xcodeproj file into your Xcode project.
  3. In your project’s settings, navigate to the General tab and add SimpleFutures.framework to the Frameworks, Libraries, and Embedded Content section.

Cocoapods Installation

To install SimpleFutures using Cocoapods, add the following line to your project’s Podfile:

pod 'SimpleFutures'

Then, run the following command in your terminal:

pod install

Carthage Installation

To install SimpleFutures using Carthage, add the following line to your project’s Cartfile:

github "simplefutures/SimpleFutures"

Then, run the following command in your terminal:

carthage update


Getting Started

Once you have installed SimpleFutures, you can start using it in your projects. Here’s a basic example to get you started:

// Import the SimpleFutures module
import SimpleFutures

// Create a future that represents an asynchronous operation
let future = Future<String, Error> { promise in
    DispatchQueue.main.asyncAfter(deadline: .now() + 2) {
        // Simulate an asynchronous operation that takes 2 seconds to complete
        if arc4random_uniform(2) == 0 {
            promise(.success("Operation completed successfully"))
        } else {
            promise(.failure(MyError.someError))
        }
    }
}

// Add a completion callback to handle the result
future.whenComplete { result in
    switch result {
    case .success(let value):
        print(value)
    case .failure(let error):
        print(error)
    }
}


Conclusion

SimpleFutures offers a lightweight and convenient way to work with asynchronous and concurrent operations in Swift. By leveraging futures and promises, you can write cleaner and more maintainable code, improving the overall quality and readability of your projects. With its intuitive interface and robust features, SimpleFutures is a valuable addition to any Swift developer’s toolkit.