https://github.com/orchetect/otatomics

Multi-platform Swift thread-safe atomics library
https://github.com/orchetect/otatomics

atomic atomics ios ios-swift macos swift swift-5 swift-5-5 tvos watchos

Last synced: 26 days ago
JSON representation

Multi-platform Swift thread-safe atomics library

• Host: GitHub
• URL: https://github.com/orchetect/otatomics
• Owner: orchetect
• License: mit
• Created: 2022-02-14T20:58:27.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-29T23:59:24.000Z (about 1 year ago)
• Last Synced: 2024-05-01T16:07:46.528Z (7 months ago)
• Topics: atomic, atomics, ios, ios-swift, macos, swift, swift-5, swift-5-5, tvos, watchos
• Language: Swift
• Homepage:
• Size: 32.2 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# OTAtomics

[![CI Build Status](https://github.com/orchetect/OTAtomics/actions/workflows/build.yml/badge.svg)](https://github.com/orchetect/OTAtomics/actions/workflows/build.yml) [![Platforms - macOS 10.10+ | iOS 9+ | tvOS 9+ | watchOS 2+ | visionOS 1+](https://img.shields.io/badge/platforms-macOS%2010.10+%20|%20iOS%209+%20|%20tvOS%209+%20|%20watchOS%202+%20|%20visionOS%201+-lightgrey.svg?style=flat)](https://developer.apple.com/swift) ![Swift 5.3-6.0](https://img.shields.io/badge/Swift-5.3–6.0-orange.svg?style=flat) [![Xcode 12-16](https://img.shields.io/badge/Xcode-12–16-blue.svg?style=flat)](https://developer.apple.com/swift) [![License: MIT](http://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)](https://github.com/orchetect/OTAtomics/blob/main/LICENSE)

Multi-platform Swift thread-safe atomics library.

The library has full unit test coverage and is actively used in production.

## Installation: Swift Package Manager (SPM)

### Dependency within an Application

1. Add the package to your Xcode project using Swift Package Manager

   - Select File → Swift Packages → Add Package Dependency

   - Add package using  `https://github.com/orchetect/OTAtomics` as the URL.

2. Import the module in your *.swift files where needed.

   ```swift

   import OTAtomics

   ```

### Dependency within a Swift Package

1. In your Package.swift file:

   ```swift

   dependencies: [

       .package(url: "https://github.com/orchetect/OTAtomics", from: "1.0.0")

   ],

   ```

   

2. Using `internal import` prevents the methods and properties in `OTOperations` from being exported to the consumer of your SPM package.

   ```swift

   internal import OTAtomics

   ```

## Documentation

Most methods are implemented as category methods so they are generally discoverable.

All methods have inline help explaining their purpose and basic usage examples.

## Author

Coded by a bunch of 🐹 hamsters in a trenchcoat that calls itself [@orchetect](https://github.com/orchetect).

## License

Licensed under the MIT license. See [LICENSE](https://github.com/orchetect/OTAtomics/blob/master/LICENSE) for details.

## Contributions

Bug fixes and improvements are welcome. Please open an issue to discuss prior to submitting PRs.