Typealias CryptoKitError

[0xTim]

Provides a typealias for CryptoKitError to hide the implementation detail of CryptoKit. Resolves #274

Checklist

• I've run tests to see all new and existing tests pass
• I've followed the code style of the rest of the project
• I've read the Contribution Guidelines
• I've updated the documentation if necessary

If you've made changes to gyb files

• I've run .script/generate_boilerplate_files_with_gyb and included updated generated files in a commit of this pull request

Motivation:

CryptoKit is an implementation detail on Apple platforms - this makes it clearer for users coming from other platforms

Modifications:

Added a type alias and updated documentation

Result:

[After your change, what will change.]

[0xTim]

@Lukasa is there anything more that needs to be done on this?

[Lukasa]

I think a lower-impact way of doing this would be to avoid renaming the file, and to put the typealiases in a file whose name ends in _boring.swift. That extension makes it clear to the tooling that keeps this in sync with CryptoKit that it's an extension for Crypto only, and so would ensure it's preserved over API syncs.

Does that work for you?

[0xTim]

@Lukasa ok updated the PR to avoid any filename changes and kept the renames to just the API docs (as opposed to changing the code to throw a CryptoError.

I think the CryptoExtras code should be updated to remove any references to CryptoKit but that can be done in a separate PR

[Lukasa]

Agreed on the follow-up PR as well.

[Lukasa]

Sorry to be a bore here, but you'll need the license header on this file.

[0xTim]

Ah good point, added

[Lukasa]

Ah shoot, can you rebuild the CMake pieces? There's a script.

[Lukasa]

Hmm, this looks incorrect. Oh shoot, I think we did some upstream work on this. Try this one? https://github.com/apple/swift-nio/blob/main/scripts/update-cmake-lists.sh

[0xTim]

That's the script I copied from when running. Do you get the same result running the script?

[fpseverino]

I think I had the same problem, do you also get the error scripts/update_cmakelists.sh: line 58: gfind: command not found or something similar? In my case the solution was to download GNU find with brew install findutils