https://github.com/Cosmo/BinaryKit
💾🔍🧮 BinaryKit helps you to break down binary data into bits and bytes, easily access specific parts and write data to binary.
https://github.com/Cosmo/BinaryKit
binary binary-data bit bits byte bytes data hacktoberfest nsdata swift
Last synced: 2 months ago
JSON representation
💾🔍🧮 BinaryKit helps you to break down binary data into bits and bytes, easily access specific parts and write data to binary.
- Host: GitHub
- URL: https://github.com/Cosmo/BinaryKit
- Owner: Cosmo
- License: mit
- Created: 2016-01-07T02:31:00.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-12-22T15:40:47.000Z (over 4 years ago)
- Last Synced: 2025-03-12T09:44:07.178Z (2 months ago)
- Topics: binary, binary-data, bit, bits, byte, bytes, data, hacktoberfest, nsdata, swift
- Language: Swift
- Homepage:
- Size: 173 KB
- Stars: 111
- Watchers: 3
- Forks: 19
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BinaryKit
BinaryKit helps you to break down binary data into bits and bytes, easily access specific parts and write data to binary.
## Access Bytes
By using any `read*` method (`readByte()`, `readBytes(quantity:)`, `readBit()`, …), BinaryKit will increment an internal cursor (or reading offset) to the end of the requested bit or byte, so the next `read*` method can continue from there.
Any `get*` method (`getByte(index:)`, `getBytes(range:)`, `getBit(index:)`, …) will give access to binary data at any given location — without incrementing the internal cursor.
Here are the methods you can call:
```swift
var binary = Binary(bytes: [0xDE, 0xAD, 0xBE, 0xEF, …])
// Reads exactly 1 byte and
// increments the cursor by 1 byte
try binary.readByte()
// Reads the next 4 bytes and
// increments the cursor by 4 bytes
try binary.readBytes(4)
// Reads the next 1 bit and
// increments the cursor by 1 bit
try binary.readBit()
// Reads the next 4 bits and
// increments the cursor by 4 bits
try binary.readBits(4)
```
### Example
```swift
var binary = Binary(bytes: [0b1_1_0_1_1_1_0_0])
// | | | | | | | |
// | | | | | | | try binary.readBit() // 0
// | | | | | | try binary.readBit() // 0
// | | | | | try binary.readBit() // 1
// | | | | try binary.readBit() // 1
// | | | try binary.readBit() // 1
// | | try binary.readBit() // 0
// | try binary.readBit() // 1
// try binary.readBit() // 1
```
This shows how easy it is, to break down an [IPv4 header](https://en.wikipedia.org/wiki/IPv4#Header).
```swift
var binary = Binary(bytes: [0x1B, 0x44, …])
let version = try binary.readBits(4)
let internetHeaderLength = try binary.readBits(4)
let differentiatedServicesCodePoint = try binary.readBits(6)
let explicitCongestionNotification = try binary.readBits(2)
let totalLength = try binary.readBytes(2)
let identification = try binary.readBytes(2)
let flags = try binary.readBits(4)
let fragmentOffset = try binary.readBits(12)
let timeToLive = try binary.readByte()
let protocolNumber = try binary.readByte()
let headerChecksum = try binary.readBytes(2)
let sourceIpAddress = try binary.readBytes(4)
let destinationIpAddress = try binary.readBytes(4)
...
```
## Store Bytes
Use the `write*` methods to store different types to binary.
```swift
var binary = Binary()
binary.writeInt32(1_350_849_546)
binary.writeString("Hello World!")
binary.writeBytes([0xFF, 0xCC, 0x00, 0x01])
binary.writeBool(true)
```
## Contact
* Devran "Cosmo" Uenal
* Twitter: [@maccosmo](http://twitter.com/maccosmo)
* LinkedIn: [devranuenal](https://www.linkedin.com/in/devranuenal)
## Other Projects
* [Clippy](https://github.com/Cosmo/Clippy) — Clippy from Microsoft Office is back and runs on macOS! Written in Swift.
* [GrammaticalNumber](https://github.com/Cosmo/GrammaticalNumber) — Turns singular words to the plural and vice-versa in Swift.
* [HackMan](https://github.com/Cosmo/HackMan) — Stop writing boilerplate code yourself. Let hackman do it for you via the command line.
* [ISO8859](https://github.com/Cosmo/ISO8859) — Convert ISO8859 1-16 Encoded Text to String in Swift. Supports iOS, tvOS, watchOS and macOS.
* [SpriteMap](https://github.com/Cosmo/SpriteMap) — SpriteMap helps you to extract sprites out of a sprite map. Written in Swift.
* [StringCase](https://github.com/Cosmo/StringCase) — Converts String to lowerCamelCase, UpperCamelCase and snake_case. Tested and written in Swift.
* [TinyConsole](https://github.com/Cosmo/TinyConsole) — TinyConsole is a micro-console that can help you log and display information inside an iOS application, where having a connection to a development computer is not possible.
## License
BinaryKit is released under the [MIT License](http://www.opensource.org/licenses/MIT).