Close Menu

swiftbitmask

Introduction

SwiftBitmask is a powerful and lightweight library for working with bitmask operations in Swift. It provides an easy-to-use interface for manipulating and creating bitmasks, making it ideal for developers working with enumeration types that have associated bitmask values.

Installation

To install SwiftBitmask, you can use CocoaPods. Simply add the following line to your Podfile:

pod 'SwiftBitmask'

After saving the Podfile, run the command pod install to install the library.

Usage

To start using SwiftBitmask, import it into your Swift file:

import SwiftBitmask

Creating a Bitmask

To create a bitmask, define an enumeration with a raw value type of UInt and conform it to the BitmaskOption protocol. Each case in the enumeration represents a different option in the bitmask.

enum MyBitmask: UInt, BitmaskOption {
case option1 = 1
case option2 = 2
case option3 = 4
}

Setting Bitmask Options

To set one or more options in the bitmask, use the set(options:) method:

var bitmask = MyBitmask()
bitmask.set(options: [.option1, .option3])

Checking Bitmask Options

To check if a particular option is set in the bitmask, use the contains(option:) method:

if bitmask.contains(option: .option2) {
print("Option 2 is set!")
}

Removing Bitmask Options

To remove one or more options from the bitmask, use the remove(options:) method:

bitmask.remove(options: [.option1])

Clearing the Bitmask

To clear the entire bitmask and remove all options, use the clear() method:

bitmask.clear()

Example

Here’s an example demonstrating how to use SwiftBitmask:

enum PaymentOptions: UInt, BitmaskOption {
case cash = 1
case creditCard = 2
case paypal = 4
case applePay = 8
}

var paymentMask = PaymentOptions()
paymentMask.set(options: [.cash, .paypal])

if paymentMask.contains(option: .creditCard) {
print("Credit card payment is enabled!")
} else {
print("Credit card payment is disabled.")
}

paymentMask.remove(options: [.paypal])

if paymentMask.contains(option: .paypal) {
print("PayPal payment is enabled!")
} else {
print("PayPal payment is disabled.")
}

Troubleshooting

  • If you’re experiencing any issues with SwiftBitmask, make sure you have the latest version installed.
  • Check the documentation for the specific methods you’re using to ensure you’re using them correctly.
  • If you’re still having trouble, feel free to create an issue on the GitHub repository for SwiftBitmask.

Conclusion

SwiftBitmask is a versatile library for working with bitmasks in Swift. It simplifies the process of creating, setting, checking, and removing options within a bitmask. By using SwiftBitmask, you can efficiently handle and manipulate bitmasks in your Swift projects.