https://github.com/asyncswiftkits/asyncchannelkit

Simple implementation of an async channel for use with Swift Concurrency
https://github.com/asyncswiftkits/asyncchannelkit

async asyncsequence concurrency swift

Last synced: 3 months ago
JSON representation

Simple implementation of an async channel for use with Swift Concurrency

• Host: GitHub
• URL: https://github.com/asyncswiftkits/asyncchannelkit
• Owner: AsyncSwiftKits
• License: mit
• Created: 2022-07-27T22:26:47.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-09-07T22:15:49.000Z (over 3 years ago)
• Last Synced: 2025-11-11T12:49:57.479Z (7 months ago)
• Topics: async, asyncsequence, concurrency, swift
• Language: Swift
• Homepage:
• Size: 29.3 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# AsyncChannelKit

![CI](https://github.com/brennanMKE/AsyncChannelKit/actions/workflows/ci.yml/badge.svg)

A simple implementation of an async channel for use with [AsyncSequence] and [AsyncIterator] which matches 

the same interface as [Channel].

When the `next()` function is called it is expected to return a value asynchronusly for an async `for` loop.

If the values are not created in response to calling this function these values will have to be provided

somehow. This channel supports sending values which the `next()` can return.

In the unit tests, a channel is created which is also a sequence. The `AyncIterator` is a nested type. 

When the iterator is created it is given the same channel. Calling `send` on the channel will make new 

values available. When the `next` function is called it creates a `continuation` which will be matched 

to a value so it can be returned. Calling `terminate` will use a `continuation` to send `nil` which tells 

the `for` loop it is done.

All of the work done by the channel is done as an actor type so that it is thread-safe. Since it only uses 

features from the Swift Standard Library it should be usable on every platform which has Swift support.

[AsyncSequence]: https://developer.apple.com/documentation/swift/asyncsequence

[AsyncIterator]: https://developer.apple.com/documentation/swift/asyncsequence/asynciterator

[Channel]: https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides/Channel.md