Remove unnecessary @ObservationIgnored in 0395-observability.md#3241
Open
ptrkstr wants to merge 1 commit intoswiftlang:mainfrom
Open
Remove unnecessary @ObservationIgnored in 0395-observability.md#3241ptrkstr wants to merge 1 commit intoswiftlang:mainfrom
ptrkstr wants to merge 1 commit intoswiftlang:mainfrom
Conversation
let properties don’t need `@ObservationIgnored`, the `@Observable` macro already skips them entirely. The macro checks `isImmutable` (whether the binding uses `let`) and excludes immutable properties from observation tracking via `isValidForObservation`:
```swift
var isValidForObservation: Bool {
!isComputed && isInstance && !isImmutable && identifier != nil
}
```
No accessors, backing storage, or mutation notifications are generated for `let` properties regardless of whether `@ObservationIgnored` is present.
Sources:
- isImmutable check: https://github.com/swiftlang/swift/blob/main/lib/Macros/Sources/ObservationMacros/Extensions.swift#L95-L97
- isValidForObservation gate: https://github.com/swiftlang/swift/blob/main/lib/Macros/Sources/ObservationMacros/ObservableMacro.swift#L238-L240
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
letproperties don’t need@ObservationIgnored, the@Observablemacro already skips them entirely. The macro checksisImmutable(whether the binding useslet) and excludes immutable properties from observation tracking viaisValidForObservation:No accessors, backing storage, or mutation notifications are generated for
letproperties regardless of whether@ObservationIgnoredis present.Sources: