A Swift micro-framework to easily deal with weak references to self inside closures

Vincent Pradeilles

Last update: Sep 1, 2022

Related tags

Overview

WeakableSelf

Context

Closures are one of Swift must-have features, and Swift developers are aware of how tricky they can be when they capture the reference of an external object, especially when this object is self.

To deal with this issue, developers are required to write additional code, using constructs such as [weak self] and guard, and the result looks like the following:

service.call(completion: { [weak self] result in
    guard let self = self else { return }
    
    // use weak non-optional `self` to handle `result`
})

Purpose of `WeakableSelf`

The purpose of this micro-framework is to provide the developer with a helper function weakify that will allow him to declaratively indicate that he wishes to use a weak non-optional reference to self in closure, and not worry about how this reference is provided.

Usage

Using this weakify function, the code above will be transformed into the much more concise:

import WeakableSelf

service.call(completion: weakify { strongSelf, result in    
    // use weak non-optional `strongSelf` to handle `result`
})

weakify works with closures that take up to 7 arguments.

Installation

Requirements

Swift 4.2+
Xcode 10+

CocoaPods

Add the following to your Podfile:

pod "WeakableSelf"

Carthage

Add the following to your Cartfile:

github "vincent-pradeilles/weakable-self"

You might also like...

Measure Swift code metrics and get reports in Xcode, Jenkins and other CI platforms.

Taylor ⚠️ Taylor is DEPRECATED. Use SwiftLint instead. A tool aimed to increase Swift code quality, by checking for conformance to code metrics. Taylo

301 Dec 24, 2022

Swift-lint-plugin - A SwiftPM plugin that adds a linting command

SwiftLintPlugin This is a SwiftPM plugin that adds a lint command. SwiftPM plugi

9 Nov 23, 2022

Aplicação Basica em Swift desenvolvida com o intuito de aplicar os conceitos estudados

Via Cep iOS Sobre - Interface do Usuario - Tecnologias - Requisitos - Autor Projeto 🛑 FINALIZADO 🛑 Sobre A Aplicação consiste em fazer buscas usando

1 Jun 3, 2022

A Swift micro-framework to easily deal with weak references to self inside closures

WeakableSelf Context Closures are one of Swift must-have features, and Swift developers are aware of how tricky they can be when they capture the refe

72 Sep 1, 2022

A simple solution for tiring [weak self] in swift

Weakifiable A simple solution for tiring [weak self] in swift Usage give this repo a Star ⭐️ Add EBWeakifiable to your Project. simply after each clos

4 Nov 6, 2021

SwiftUI project demonstrating how weak self works

SwiftUI-weak-self SwiftUI project demonstrating how weak self works Inspired by Swiftful

2 Oct 14, 2022

📱💬🚦 TinyConsole is a micro-console that can help you log and display information inside an iOS application, where having a connection to a development computer is not possible.

TinyConsole TinyConsole is a tiny log console to display information while using your iOS app and written in Swift. Usage Wrap your Main ViewControlle

2k Jan 3, 2023

A Swift sample code to reads ISO 10303-21 exchange structures (STEP P21 files for AP242) split into multiple files using external references approach.

multipleP21ReadsSample A Swift sample code to reads ISO 10303-21 exchange structures (STEP P21 files for AP242) split into multiple files using extern

1 Nov 23, 2021

SwiftySound is a simple library that lets you deal with Swift sounds easily

SwiftySound Overview SwiftySound is a simple library that lets you deal with Swift sounds easily. Static methods Sound.play(file: "dog.wav") Sound.pla

1.1k Dec 17, 2022

PySwiftyRegex - Easily deal with Regex in Swift in a Pythonic way

PySwiftyRegex Easily deal with Regex in Swift in a Pythonic way.

232 Oct 12, 2022

Easily deal with Regex in Swift in a Pythonic way

PySwiftyRegex Easily deal with Regex in Swift in a Pythonic way. 简体中文日本語 한국어 This is Easy import PySwiftyRegex if let m = re.search("[Tt]his is (.*?

232 Oct 12, 2022

LaiFeng IOS Live Kit,H264 and AAC Hard coding，support GPUImage Beauty， rtmp transmission，weak network lost frame，Dynamic switching rate

LFLiveKit LFLiveKit is a opensource RTMP streaming SDK for iOS. Features Background recording Support horizontal vertical recording Support Beauty Fac

4.3k Jan 6, 2023

Comments

Order issue
Hi! Thanks for this great implementation!

Although, its usage really looks like another operator that can be found in RxSwiftExt (I don't know if you ever heard of if :trollface: ) and the order in the arguments isn't consistent between the two methods

for now it takes two parametters, first the passed parameter and then the self which results in a call like this :

.subscribe(onNext: weakify { data, strongSelf in strongSelf.doSomething(with: data) })

I find it kind of awkward considering that when we use .withUnretained(self) the order is reversed.

.withUnretained(self) .subscribe(onNext: { strongSelf, data in strongSelf.doSomething(with: data) })

Also in the general case in closures the compiler enforces the [weak/unretained self] to be before the arguments of the closure

.subscribe(onNext: { [unretained self] data in self.doSomething(with: data) })

what do you think about changing the order in the new method ? If you agree I can obviously make a pull request with the changes :)

Cheers!
opened by HugoSay 0

A Swift micro-framework to easily deal with weak references to self inside closures

Related tags

Overview

WeakableSelf

Context

Purpose of WeakableSelf

Usage

Installation

Requirements

CocoaPods

Carthage

You might also like...

Measure Swift code metrics and get reports in Xcode, Jenkins and other CI platforms.

Swift-lint-plugin - A SwiftPM plugin that adds a linting command

Aplicação Basica em Swift desenvolvida com o intuito de aplicar os conceitos estudados

A Swift micro-framework to easily deal with weak references to self inside closures

A simple solution for tiring [weak self] in swift

SwiftUI project demonstrating how weak self works

📱💬🚦 TinyConsole is a micro-console that can help you log and display information inside an iOS application, where having a connection to a development computer is not possible.

A Swift sample code to reads ISO 10303-21 exchange structures (STEP P21 files for AP242) split into multiple files using external references approach.

SwiftySound is a simple library that lets you deal with Swift sounds easily

PySwiftyRegex - Easily deal with Regex in Swift in a Pythonic way

Easily deal with Regex in Swift in a Pythonic way

LaiFeng IOS Live Kit,H264 and AAC Hard coding，support GPUImage Beauty， rtmp transmission，weak network lost frame，Dynamic switching rate

Short examples and references to work with property wrappers in SwiftUI.

Folder References With Xcode Gen

Elegant manager to easily deal with UIPickerView

TupleResult - A micro library that easily converts tuple result into Swift.Result

T - A simple testing framework using closures and errors

A micro-framework that leverages Swift Property Wrappers to implement the Service Locator pattern

Aftermath is a stateless message-driven micro-framework in Swift

Comments

Order issue

Owner

Vincent Pradeilles

Flexible bug report framework for iOS

Lint anything by combining the power of Swift & regular expressions.

A tool for Swift code modification intermediating between code generation and formatting.

SwiftCop is a validation library fully written in Swift and inspired by the clarity of Ruby On Rails Active Record validations.

A command-line tool and Xcode Extension for formatting Swift code

A tool to enforce Swift style and conventions.

An Xcode formatter plug-in to format your swift code.

Cross-platform static analyzer and linter for Swift.

Type-safe observable values and collections in Swift

💊 Syntactic sugar for Swift do-try-catch

Purpose of `WeakableSelf`