Skip to content

feat: add discardableResult to ParseObject methods #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cbaker6 merged 5 commits into from
Jul 19, 2022
Merged

feat: add discardableResult to ParseObject methods #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5ea60f3
discardableResult
vdkdamian Jul 16, 2022
91fef53
Update changelog
vdkdamian Jul 16, 2022
8b935d6
Fixed SwiftLint
vdkdamian Jul 18, 2022
4098c0a
fixed changelog
vdkdamian Jul 19, 2022
6a887e3
ParseInstallation & ParseUser
vdkdamian Jul 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

### main

__Improvements__
- Added discardableResult to allow developers to choose whether or not certain functions should return a result ([#385](https://github.com/parse-community/Parse-Swift/pull/385)), thanks to [Damian Van de Kauter](https://github.com/vdkdamian).

[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.8.0...main)
* _Contributing to this repo? Add info about your change here to be included in the next release_

Expand Down
44 changes: 22 additions & 22 deletions Sources/ParseSwift/Objects/ParseInstallation+async.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ public extension ParseInstallation {
- note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
desires a different policy, it should be inserted in `options`.
*/
func fetch(includeKeys: [String]? = nil,
options: API.Options = []) async throws -> Self {
@discardableResult func fetch(includeKeys: [String]? = nil,
options: API.Options = []) async throws -> Self {
try await withCheckedThrowingContinuation { continuation in
self.fetch(includeKeys: includeKeys,
options: options,
Expand Down Expand Up @@ -54,8 +54,8 @@ public extension ParseInstallation {
- note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
desires a different policy, it should be inserted in `options`.
*/
func save(ignoringCustomObjectIdConfig: Bool = false,
options: API.Options = []) async throws -> Self {
@discardableResult func save(ignoringCustomObjectIdConfig: Bool = false,
options: API.Options = []) async throws -> Self {
try await withCheckedThrowingContinuation { continuation in
self.save(ignoringCustomObjectIdConfig: ignoringCustomObjectIdConfig,
options: options,
Expand All @@ -69,7 +69,7 @@ public extension ParseInstallation {
- returns: Returns saved `ParseInstallation`.
- throws: An error of type `ParseError`.
*/
func create(options: API.Options = []) async throws -> Self {
@discardableResult func create(options: API.Options = []) async throws -> Self {
try await withCheckedThrowingContinuation { continuation in
self.create(options: options,
completion: continuation.resume)
Expand All @@ -83,7 +83,7 @@ public extension ParseInstallation {
- throws: An error of type `ParseError`.
- important: If an object replaced has the same objectId as current, it will automatically replace the current.
*/
func replace(options: API.Options = []) async throws -> Self {
@discardableResult func replace(options: API.Options = []) async throws -> Self {
try await withCheckedThrowingContinuation { continuation in
self.replace(options: options,
completion: continuation.resume)
Expand All @@ -97,7 +97,7 @@ public extension ParseInstallation {
- throws: An error of type `ParseError`.
- important: If an object updated has the same objectId as current, it will automatically update the current.
*/
internal func update(options: API.Options = []) async throws -> Self {
@discardableResult internal func update(options: API.Options = []) async throws -> Self {
try await withCheckedThrowingContinuation { continuation in
self.update(options: options,
completion: continuation.resume)
Expand Down Expand Up @@ -135,8 +135,8 @@ public extension Sequence where Element: ParseInstallation {
- throws: An error of type `ParseError`.
- important: If an object fetched has the same objectId as current, it will automatically update the current.
*/
func fetchAll(includeKeys: [String]? = nil,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
@discardableResult func fetchAll(includeKeys: [String]? = nil,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
try await withCheckedThrowingContinuation { continuation in
self.fetchAll(includeKeys: includeKeys,
options: options,
Expand Down Expand Up @@ -174,10 +174,10 @@ public extension Sequence where Element: ParseInstallation {
- note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
desires a different policy, it should be inserted in `options`.
*/
func saveAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
ignoringCustomObjectIdConfig: Bool = false,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
@discardableResult func saveAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
ignoringCustomObjectIdConfig: Bool = false,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
try await withCheckedThrowingContinuation { continuation in
self.saveAll(batchLimit: limit,
transaction: transaction,
Expand All @@ -204,9 +204,9 @@ public extension Sequence where Element: ParseInstallation {
- note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
desires a different policy, it should be inserted in `options`.
*/
func createAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
@discardableResult func createAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
try await withCheckedThrowingContinuation { continuation in
self.createAll(batchLimit: limit,
transaction: transaction,
Expand All @@ -233,9 +233,9 @@ public extension Sequence where Element: ParseInstallation {
- note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
desires a different policy, it should be inserted in `options`.
*/
func replaceAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
@discardableResult func replaceAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
try await withCheckedThrowingContinuation { continuation in
self.replaceAll(batchLimit: limit,
transaction: transaction,
Expand Down Expand Up @@ -288,9 +288,9 @@ public extension Sequence where Element: ParseInstallation {
objects in the transaction. The developer should ensure their respective Parse Servers can handle the limit or else
the transactions can fail.
*/
func deleteAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Void, ParseError>)] {
@discardableResult func deleteAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Void, ParseError>)] {
try await withCheckedThrowingContinuation { continuation in
self.deleteAll(batchLimit: limit,
transaction: transaction,
Expand Down
44 changes: 22 additions & 22 deletions Sources/ParseSwift/Objects/ParseObject+async.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ public extension ParseObject {
- note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
desires a different policy, it should be inserted in `options`.
*/
func fetch(includeKeys: [String]? = nil,
options: API.Options = []) async throws -> Self {
@discardableResult func fetch(includeKeys: [String]? = nil,
options: API.Options = []) async throws -> Self {
try await withCheckedThrowingContinuation { continuation in
self.fetch(includeKeys: includeKeys,
options: options,
Expand All @@ -41,8 +41,8 @@ public extension ParseObject {
- returns: Returns the saved `ParseObject`.
- throws: An error of type `ParseError`.
*/
func save(ignoringCustomObjectIdConfig: Bool = false,
options: API.Options = []) async throws -> Self {
@discardableResult func save(ignoringCustomObjectIdConfig: Bool = false,
options: API.Options = []) async throws -> Self {
try await withCheckedThrowingContinuation { continuation in
self.save(ignoringCustomObjectIdConfig: ignoringCustomObjectIdConfig,
options: options,
Expand All @@ -56,7 +56,7 @@ public extension ParseObject {
- returns: Returns the saved `ParseObject`.
- throws: An error of type `ParseError`.
*/
func create(options: API.Options = []) async throws -> Self {
@discardableResult func create(options: API.Options = []) async throws -> Self {
try await withCheckedThrowingContinuation { continuation in
self.create(options: options,
completion: continuation.resume)
Expand All @@ -69,7 +69,7 @@ public extension ParseObject {
- returns: Returns the saved `ParseObject`.
- throws: An error of type `ParseError`.
*/
func replace(options: API.Options = []) async throws -> Self {
@discardableResult func replace(options: API.Options = []) async throws -> Self {
try await withCheckedThrowingContinuation { continuation in
self.replace(options: options,
completion: continuation.resume)
Expand All @@ -82,7 +82,7 @@ public extension ParseObject {
- returns: Returns the saved `ParseObject`.
- throws: An error of type `ParseError`.
*/
internal func update(options: API.Options = []) async throws -> Self {
@discardableResult internal func update(options: API.Options = []) async throws -> Self {
try await withCheckedThrowingContinuation { continuation in
self.update(options: options,
completion: continuation.resume)
Expand Down Expand Up @@ -118,8 +118,8 @@ public extension Sequence where Element: ParseObject {
`ParseError` if it failed.
- throws: An error of type `ParseError`.
*/
func fetchAll(includeKeys: [String]? = nil,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
@discardableResult func fetchAll(includeKeys: [String]? = nil,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
try await withCheckedThrowingContinuation { continuation in
self.fetchAll(includeKeys: includeKeys,
options: options,
Expand Down Expand Up @@ -156,10 +156,10 @@ public extension Sequence where Element: ParseObject {
- note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
desires a different policy, it should be inserted in `options`.
*/
func saveAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
ignoringCustomObjectIdConfig: Bool = false,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
@discardableResult func saveAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
ignoringCustomObjectIdConfig: Bool = false,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
try await withCheckedThrowingContinuation { continuation in
self.saveAll(batchLimit: limit,
transaction: transaction,
Expand All @@ -186,9 +186,9 @@ public extension Sequence where Element: ParseObject {
- note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
desires a different policy, it should be inserted in `options`.
*/
func createAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
@discardableResult func createAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
try await withCheckedThrowingContinuation { continuation in
self.createAll(batchLimit: limit,
transaction: transaction,
Expand All @@ -214,9 +214,9 @@ public extension Sequence where Element: ParseObject {
- note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
desires a different policy, it should be inserted in `options`.
*/
func replaceAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
@discardableResult func replaceAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Self.Element, ParseError>)] {
try await withCheckedThrowingContinuation { continuation in
self.replaceAll(batchLimit: limit,
transaction: transaction,
Expand Down Expand Up @@ -267,9 +267,9 @@ public extension Sequence where Element: ParseObject {
objects in the transaction. The developer should ensure their respective Parse Servers can handle the limit or else
the transactions can fail.
*/
func deleteAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Void, ParseError>)] {
@discardableResult func deleteAll(batchLimit limit: Int? = nil,
transaction: Bool = ParseSwift.configuration.isUsingTransactions,
options: API.Options = []) async throws -> [(Result<Void, ParseError>)] {
try await withCheckedThrowingContinuation { continuation in
self.deleteAll(batchLimit: limit,
transaction: transaction,
Expand Down
Loading