Skip to content

apple/swift-nio-extras

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a670838 · Jan 13, 2025
Dec 18, 2024
Jan 13, 2025
Jan 13, 2025
May 15, 2018
Nov 15, 2024
Oct 10, 2019
Oct 28, 2024
Dec 11, 2024
Oct 28, 2024
Jun 6, 2023
Oct 28, 2024
Jan 14, 2019
May 15, 2018
Jan 12, 2023
Dec 13, 2024
Dec 11, 2024
Mar 9, 2021

Repository files navigation

NIOExtras

NIOExtras is a good place for code that is related to NIO but not core. It can also be used to incubate APIs for tasks that are possible with core-NIO but are cumbersome today.

What makes a good contribution to NIOExtras?

  • a protocol encoder/decoder pair (also called "codec") that is often used but is small enough so it doesn't need its own repository
  • a helper to achieve a task that is harder-than-necessary to achieve with core-NIO

Code Quality / Stability

All code will go through code review like in the other repositories related to the SwiftNIO project.

swift-nio-extras part of the SwiftNIO 2 family of repositories and depends on the following:

  • swift-nio, version 2.30.0 or better.
  • Swift 5.7.1
  • zlib and its development headers installed on the system. But don't worry, you'll find zlib on pretty much any UNIX system that can compile any sort of code.

To depend on swift-nio-extras, put the following in the dependencies of your Package.swift:

.package(url: "https://github.com/apple/swift-nio-extras.git", from: "1.0.0"),

Support for older Swift versions

The most recent versions of SwiftNIO Extras support Swift 5.7.1 and newer. The minimum Swift version supported by SwiftNIO Extras releases are detailed below:

SwiftNIO Extras Minimum Swift Version
1.0.0 ..< 1.10.0 5.0
1.10.0 ..< 1.11.0 5.2
1.11.0 ..< 1.14.0 5.4
1.14.0 ..< 1.19.0 5.5.2
1.19.0 ..< 1.20.0 5.6
1.20.0 ..< 1.23.0 5.7.1
1.23.0 ... 5.8

On the nio-extras-0.1 branch, you can find the swift-nio-extras version for the SwiftNIO 1 family. It requires Swift 4.1 or better.

Current Contents