Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattmassicotte/queue
A queue for Swift concurrency
https://github.com/mattmassicotte/queue
concurrency swift
Last synced: 14 days ago
JSON representation
A queue for Swift concurrency
- Host: GitHub
- URL: https://github.com/mattmassicotte/queue
- Owner: mattmassicotte
- License: bsd-3-clause
- Created: 2023-06-15T13:46:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-16T10:48:18.000Z (3 months ago)
- Last Synced: 2024-10-10T04:09:38.725Z (about 1 month ago)
- Topics: concurrency, swift
- Language: Swift
- Homepage:
- Size: 78.1 KB
- Stars: 257
- Watchers: 6
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![Build Status][build status badge]][build status]
[![Platforms][platforms badge]][platforms]
[![Documentation][documentation badge]][documentation]
# Queue
A queue for Swift concurrency
This package exposes a single type: `AsyncQueue`. Conceptually, `AsyncQueue` is very similar to a `DispatchQueue` or `OperationQueue`. However, unlike these an `AsyncQueue` can accept async blocks. This exists to more easily enforce ordering across unstructured tasks without requiring explicit dependencies between them.
I've found this helpful when interfacing stateful asynchronous systems with synchronous code.
## Integration
```swift
dependencies: [
.package(url: "https://github.com/mattmassicotte/Queue", from: "0.1.4")
]
```
## Usage
```swift
let queue = AsyncQueue()
queue.addOperation {
await asyncFunction()
await anotherAsyncFunction()
}
// This can can also return the underlying Task,
// so you can cancel, or await a value
let task = queue.addOperation {
return await makeValue()
}
let value = try await task.value
```
By default, `AsyncQueue` will only run one operation at a time. But, it can be configured as a concurrent queue.
```swift
let queue = AsyncQueue(attributes: [.concurrent])
// these two may run concurrently
queue.addOperation { await asyncFunction() }
queue.addOperation { await asyncFunction() }
// This will only run once existing operations are complete, and will
// prevent new operations from starting until done
queue.addBarrierOperation {
await asyncFunction()
}
```
The `AsyncQueue` type has an `errorSequence` property, which can be used to detect uncaught errors out of band.
```swift
let queue = AsyncQueue(attributes: [.publishErrors])
Task {
for await error in queue.errorSequence {
print(error)
}
}
```
This package was inspired by [Semaphore][semaphore], which is another concurrency-related synchronization system that I've found very useful.
## Alternatives
- [swift-async-queue](https://github.com/dfed/swift-async-queue)
## Contributing and Collaboration
I'd love to hear from you! Get in touch via [mastodon](https://mastodon.social/@mattiem), an issue, or a pull request.
I prefer collaboration, and would love to find ways to work together if you have a similar project.
I prefer indentation with tabs for improved accessibility. But, I'd rather you use the system you want and make a PR than hesitate because of whitespace.
By participating in this project you agree to abide by the [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
[build status]: https://github.com/mattmassicotte/Queue/actions
[build status badge]: https://github.com/mattmassicotte/Queue/workflows/CI/badge.svg
[platforms]: https://swiftpackageindex.com/mattmassicotte/Queue
[platforms badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fmattmassicotte%2FQueue%2Fbadge%3Ftype%3Dplatforms
[semaphore]: https://github.com/groue/Semaphore
[documentation]: https://swiftpackageindex.com/mattmassicotte/Queue/main/documentation
[documentation badge]: https://img.shields.io/badge/Documentation-DocC-blue