Swiftpack.co - DrAma999/BitWiser as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by DrAma999.
DrAma999/BitWiser 0.0.2
A simple library to help you in dealing with bytes, bits and nibbles :-)
⭐️ 2
🕓 2 days ago
.package(url: "https://github.com/DrAma999/BitWiser.git", from: "0.0.2")

Swift codecov CodeFactor

BitWiser

Bitwiser is a collection of methods and properties that makes you work with bits, bytes and nibbles a piece of cake

The project is in early stages of development feel free to make pull requests for more funcionalities

FEATURES

  • No more bit masking. Access single bit values
  • Coverting from bytes array to Data and back has never been easier
  • Print Data into hex string
  • Set, reset, query, toggle each bit
  • Subscript
  • Chaining methods
  • Extensive code coverage
  • Multiplatform: iOS, macOS, tvOS, watchOS, Linux, Windows

INSTALLATION

Use Swift package manager. Add the following dependency to your Package.swift file:

.package(url: "https://github.com/DrAma999/BitWiser.git", from: "0.0.2")

Or simply add the URL from XCode menu Swift packages.

HOW TO USE IT

A Byte is simply a UInt8 that has been extended to access single bit values. A Bit is an enumeration that can assume two values .one or .zero.

 var value = Byte(0b1010_1010)
 let bits = value.bits 
 print(bits)
 // [0, 1, 0, 1, 0, 1, 0, 1]

Note: Bits representation is shown as an array of Bit where the array index 0 represents the least significant bit

After creating a Byte you can read in its position in different ways: Subscript

let bit = value[0]

Method

// Query the value
let bit = value.bit(0)
// Ask if bit is set (equal to one)
let isSet = value.isBitSet(0)

Properties

let bit = value.b0

After creating a mutable Byte you can write in its position in different ways: Subscript

value[0] = 1

Method

// Set the specified bit to 1
value.setBit(0)
// Reset the specified bit to 0
value.resetBit(0)
// Toggle the specified bit. If the bit in position zero is one it becomes zero and viceversa
value.resetBit(0)
// Change the value of the specified bit to one
value.changeBit(0, to: .one )

// Chaining modifiers that return a new value without mutating
let newValue = value
              .settingBit(0)
              .resettingBit(3)
              .togglingBit(4)

Properties

value.b0 = .zero

Pretty sure that if you worked in IOT you had an embedded engineer that put some infomration inside a nibble. With bit wiser you can extract nibbles from a byte:

 let value: Byte = 0b01011111
 let (msb, lsb) = value.nibbles

There are also a lot of methods and facilities to work with bit bites and nibbles.

CONTRIBUTING

Since I'm working on this project in my spare time any help is appreciated. Feel free to make a pull request.

THANKS

Icon made by  Freepik  from  www.flaticon.com

LICENSE

MIT License

Copyright (c) 2021 Andrea Finollo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

GitHub

link
Stars: 2
Last commit: 3 days ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Related Packages

Release Notes

0.0.2
3 days ago

What's Changed

New Contributors

Full Changelog: https://github.com/DrAma999/BitWiser/compare/0.0.1...0.0.2

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics