CaptureContext/swift-capture

A mechanism for safe capturing & weakifying objects in Swift.

swift-capture

A mechanism for ergonomic and safe capturing & weakifying objects in Swift.

Usage Examples

Without Capture

With Capture

---

Default

{ [weak self] in 
  guard let self else { return }
  /// ...
}

capture { _self in
  /// ...
}

---

Multiple parameters

{ [weak self] a, b, c in 
  guard let self else { return }
  /// ...
}

capture { _self, a, b, c in 
  /// ...
}

---

Methods

{ [weak self] in 
  guard let self = self else { return }
  self.someMethod()
}

capture(in: <#Type#>.someMethod)

---

Return values

let object.dataSource = { [weak self] in
  guard let self = self else { return [] }
  return self.data
}

let object.dataSource = capture(orReturn: [], in: \.data)

Installation

Basic

You can add swift-capture to an Xcode project by adding it as a package dependency.

1. From the File menu, select Swift Packages › Add Package Dependency…
2. Enter "https://github.com/capturecontext/swift-capture" into the package repository URL text field
3. Choose products you need to link them to your project.

Recommended

If you use SwiftPM for your project, you can add weak to your package file. Also my advice is to use SSH.

.package(
  url: "git@github.com:capturecontext/swift-capture.git",
  .upToNextMajor("3.0.0")
)

Do not forget about target dependencies:

.product(
    name: "Capture", 
    package: "swift-capture"
)

License

This library is released under the MIT license. See LICENSE for details.