apple/swift-nio

NIOLoopBound should get `unchecked` variants that are truly free in release mode

Open

#2,506 opened on Aug 17, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Swift (749 forks)batch import
good first issuekind/enhancement

Repository metrics

Stars
 (8,453 stars)
PR merge metrics
 (Avg merge 9d 10h) (15 merged PRs in 30d)

Description

NIOLoopBound(Box) is super useful when adopting Sendable but the eventLoop.preconditionInEventLoop() checks everywhere are expensive and -- for repeated accesses -- unnecessary.

There should be unchecked variants of init, get and set value that do eventLoop.assertInEventLoop() instead. Together with @inlinable that should become completely free in release mode (and still check in debug).

Docs:

Contributor guide

Research direction
Implement unchecked variants of NIOLoopBound init, get, and set that use eventLoop.assertInEventLoop() instead of preconditionInEventLoop(), and mark them @inlinable. Ensure they become free in release mode while still checking in debug.
Tech stack
swift
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Swift
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65