swift-extras-base64

1.0.0

Star
Base64 encode and decode without the use of Foundation in pure Swift.
swift base64 swift-server
swift-extras/swift-extras-base64

What's New

v1.0.0

2024-05-14T15:27:18Z

Finally a 1.0 for swift-extras-base64

Major release changes

  • Renamed Base32.encodeBytes to Base32.encodeToBytes. PR #33
  • Renamed Base32.encodeString to Base32.encodeToString. PR #33
  • Renamed Base64.encodeBytes to Base64.encodeToBytes. PR #33
  • Renamed Base64.encodeString to Base64.encodeToString. PR #33

Minor release changes

  • Support parsing padding characters in Base32.decode. PR #32
  • Improved performance of Base32.encode. PR #32
  • Added fast path for Base32.decode when not parsing whitespace characters, include option .allowNullCharacters as parameter to support parsing whitespace characters. PR #36

Other changes

swift-extras-base64

Swift 5.1 github-actions codecov macOS tuxOS

This package provides a base64 encoder and decoder in Swift without the use of Foundation. The implementation is RFC4648 complient and is faster than the Foundation base64 implementation.

To achieve performance the implementation uses Chromium precomputed lookup tables and makes heavy use of unsafe swift API. When Swift has better support for SIMD instructions this might be an area worth exploring.

Status

  • support for base64 and base64url
  • faster than Foundation
  • padding can be omitted
  • decoding can ignore line breaks
  • encoding can insert line breaks

A former implementation of this package is used in swift-nio's websocket implementation.

Performance

Super simple performance test to ensure speediness of this implementation. Encoding and decoding 1m times the base64 string:

AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWltcXV5fYGFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6e3x9fn+AgYKDhIWGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6ChoqOkpaanqKmqq6ytrq+wsbKztLW2t7i5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+/w==

Tests were run on a MacBook Pro (16-inch, late 2019). Processor: 2.4 GHz 8-Core Intel Core i9.

macOS - swift 5.3

Encoding Decoding
Foundation 2.08s 2.15s
swift-extras-base64 0.66s 0.54s
Speedup 3x 4x

Linux - swift 5.3

Encoding Decoding
Foundation 1.01s 5.5s
swift-extras-base64 0.27s 0.41s
Speedup 3x ~10x

Literature for a faster algorithm

I would really like to speed up this project further to be way faster than it is today. Some food for thought of how this could be tackled can be found here:

Alternatives

As of today (2019-12-10), the author is aware of only one alternative that offers merely encoding.

Description

  • Swift Tools 5.3.0
View More Packages from this Author

Dependencies

  • None
Last updated: Sun May 19 2024 06:25:26 GMT-0900 (Hawaii-Aleutian Daylight Time)