starred/CoreStore-JohnEstropia
1
0
Fork 0
mirror of https://github.com/JohnEstropia/CoreStore.git synced 2026-09-02 08:37:21 +02:00
Code Issues 95 Packages Projects Releases 10 Wiki Activity

perform(synchronous:) is not a rethrowing method as documented #159

New Issue
Closed
opened 2025-12-29 18:23:51 +01:00 by adam · 3 comments
adam commented 2025-12-29 18:23:51 +01:00
Owner
Copy Link
Copy Source

Originally created by @sidmani on GitHub (Aug 15, 2017).

The documentation for DataStack.perform(synchronous:) states:
"Any errors thrown from inside the task will be rethrown from perform(synchronous:)".
However, the signature is marked throws, not rethrows.
public func perform<T>(synchronous task: ((_ transaction: SynchronousDataTransaction) throws -> T), waitForAllObservers: Bool = true) throws -> T
Documentation error?

Originally created by @sidmani on GitHub (Aug 15, 2017). The documentation for `DataStack.perform(synchronous:)` states: "Any errors thrown from inside the `task` will be rethrown from `perform(synchronous:)`". However, the signature is marked `throws`, not `rethrows`. `public func perform<T>(synchronous task: ((_ transaction: SynchronousDataTransaction) throws -> T), waitForAllObservers: Bool = true) throws -> T` Documentation error?
adam added the question label 2025-12-29 18:23:51 +01:00
adam closed this issue 2025-12-29 18:23:51 +01:00
adam commented 2025-12-29 18:23:52 +01:00
Author
Owner
Copy Link
Copy Source

@JohnEstropia commented on GitHub (Aug 15, 2017):

perform(synchronous:) just promises to "rethrow", that is to propagate, any errors you throw from inside the closure, not that it accepts non-throwing closures. It's explicitly throws because

  1. The only way to cancel a transaction is to call throw transaction.cancel()
  2. Declaring rethrows gives the illusion that non-throwing closures will never fail, which is not true (save errors may still be emitted)
@JohnEstropia commented on GitHub (Aug 15, 2017): `perform(synchronous:)` just promises to "rethrow", that is to propagate, any errors you `throw` from inside the closure, not that it accepts non-throwing closures. It's explicitly `throws` because 1. The only way to cancel a transaction is to call `throw transaction.cancel()` 2. Declaring `rethrows` gives the illusion that non-throwing closures will never fail, which is not true (save errors may still be emitted)
adam commented 2025-12-29 18:23:52 +01:00
Author
Owner
Copy Link
Copy Source

@sidmani commented on GitHub (Aug 15, 2017):

Gotcha, I think changing the word "rethrow" to "propagate" or something in the doc would make it clearer since rethrows is a keyword.

@sidmani commented on GitHub (Aug 15, 2017): Gotcha, I think changing the word "rethrow" to "propagate" or something in the doc would make it clearer since rethrows is a keyword.
adam commented 2025-12-29 18:23:52 +01:00
Author
Owner
Copy Link
Copy Source

@JohnEstropia commented on GitHub (Aug 15, 2017):

Thanks, I see the confusion. Will reword similar places in the documentations 👍

@JohnEstropia commented on GitHub (Aug 15, 2017): Thanks, I see the confusion. Will reword similar places in the documentations 👍
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
abandoned
corestore bug
discussion
duplicate
enhancement
fixed
fixed
help wanted
in progress
investigating
ios/compiler bug
irreproducible
looking for workarounds
not a bug
pending
pending docs update
pull-request
Mirrored from GitHub Pull Request
 question
regression
user bug
wontfix
No labels question
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/CoreStore-JohnEstropia#159