Skip to content

Commit 3888d6a

Browse files
committed
Updated doc
1 parent 9ce62d4 commit 3888d6a

File tree

208 files changed

+209
-209
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

208 files changed

+209
-209
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ request.predicate = .safe(on: User.self) { (10...20).contains($0.score) }
5959
```
6060

6161
## `NSPredicate`, `Predicate`
62-
Why not using `Predicate` directly? Two reasons:
62+
Why not using the `Predicate` macro? Two reasons.
6363
- It works only with SwiftData as of today (so iOS 17+, macOS 14+ ...). It doesn't work with CoreData.
6464
- It doesn't support everything that `NSPredicate` does when fetching a CoreData store.
6565

6666
Meanwhile, `NSPredicate` requires to write everything in a `String`, which is very error-prone.
6767

68-
Whereas this library tries to reach three objectives:
68+
Whereas this library tries to cover three objectives:
6969
1. Use compiler-checking to evaluate predicates and avoid runtime errors.
7070
2. Writing a request and especially a predicate should feel as natural as possible in Swift.
7171
3. No feature of NSPredicate to fetch a CoreData store should be left behind.

Sources/SafeFetching/SafeFetching.docc/Articles/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,6 @@ try User.request()
8383
.fetch(in: context) // [User]
8484
```
8585

86-
### What's Next
86+
### Where to Go Next
8787
- Learn more about predicates by reading <doc:build-predicates>.
8888
- Learn more about request building by reading <doc:build-requests>.

docs/data/documentation/safefetching.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!"},{"kind":"text","text":" "},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"E"},{"kind":"text","text":">("},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Builders","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders","preciseIdentifier":"s:12SafeFetching8BuildersO"},{"kind":"text","text":"."},{"text":"Predicate","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Builders","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders","preciseIdentifier":"s:12SafeFetching8BuildersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Predicate","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":"> ","kind":"text"},{"text":"where","kind":"keyword"},{"text":" ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Fetchable","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Fetchable","preciseIdentifier":"s:12SafeFetching9FetchableP","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["macOS"]}]}],"variants":[{"paths":["\/documentation\/safefetching\/!(_:)-1nel2"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/SafeFetching\/documentation\/SafeFetching"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","identifier":{"url":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/!(_:)-1nel2","interfaceLanguage":"swift"},"sections":[],"metadata":{"role":"symbol","symbolKind":"op","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!","kind":"identifier"},{"text":" ","kind":"text"},{"text":"<","kind":"text"},{"text":"E","kind":"genericParameter"},{"text":">(","kind":"text"},{"preciseIdentifier":"s:12SafeFetching8BuildersO","text":"Builders","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","text":"Predicate","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:12SafeFetching8BuildersO","text":"Builders","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","text":"Predicate","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"roleHeading":"Operator","externalID":"s:12SafeFetching1nopyAA8BuildersO9PredicateCy_xGAgA9FetchableRzlF","modules":[{"name":"SafeFetching"}],"title":"!(_:)"},"references":{"doc://SafeFetching/documentation/SafeFetching":{"role":"collection","abstract":[{"text":"Convenience functions around ","type":"text"},{"type":"codeVoice","code":"CoreData"},{"text":" fetching.","type":"text"}],"title":"SafeFetching","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching","url":"\/documentation\/safefetching","type":"topic","kind":"symbol"},"doc://SafeFetching/documentation/SafeFetching/Builders/Predicate":{"url":"\/documentation\/safefetching\/builders\/predicate","abstract":[{"text":"Generated from ","type":"text"},{"isActive":true,"identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/FetchableMember","type":"reference"},{"text":" operations to wrap a ","type":"text"},{"code":"NSPredicate","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Predicate","kind":"identifier"}],"navigatorTitle":[{"text":"Predicate","kind":"identifier"}],"title":"Builders.Predicate","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate","role":"symbol"},"doc://SafeFetching/documentation/SafeFetching/Builders":{"url":"\/documentation\/safefetching\/builders","role":"symbol","title":"Builders","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Builders","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders","abstract":[{"text":"Namespace to hide most building types used by SafeFetching to make requests.","type":"text"}],"type":"topic","navigatorTitle":[{"text":"Builders","kind":"identifier"}]},"doc://SafeFetching/documentation/SafeFetching/Fetchable":{"navigatorTitle":[{"kind":"identifier","text":"Fetchable"}],"url":"\/documentation\/safefetching\/fetchable","abstract":[{"text":"Implemented by a ","type":"text"},{"code":"NSManagedObject","type":"codeVoice"},{"text":" to offer fetching using SafeFetching API.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Fetchable"}],"title":"Fetchable","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Fetchable"},"doc://SafeFetching/documentation/SafeFetching/FetchableMember":{"kind":"symbol","url":"\/documentation\/safefetching\/fetchablemember","abstract":[{"text":"Stores types and identifier of an entity and attribute or relationship that can be used for fetching.","type":"text"}],"identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/FetchableMember","title":"FetchableMember","navigatorTitle":[{"text":"FetchableMember","kind":"identifier"}],"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"FetchableMember","kind":"identifier"}],"type":"topic"},"doc://SafeFetching/documentation/SafeFetching/!(_:)-1nel2":{"abstract":[],"url":"\/documentation\/safefetching\/!(_:)-1nel2","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/!(_:)-1nel2","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!","kind":"identifier"},{"text":" ","kind":"text"},{"text":"<","kind":"text"},{"text":"E","kind":"genericParameter"},{"text":">(","kind":"text"},{"text":"Builders","kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO"},{"text":".","kind":"text"},{"text":"Predicate","kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Builders","kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO"},{"text":".","kind":"text"},{"text":"Predicate","kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"!(_:)","role":"symbol","kind":"symbol","type":"topic"}}}
1+
{"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!"},{"kind":"text","text":" "},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"E"},{"kind":"text","text":">("},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders","preciseIdentifier":"s:12SafeFetching8BuildersO","text":"Builders"},{"kind":"text","text":"."},{"preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate","text":"Predicate","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:12SafeFetching8BuildersO","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders","text":"Builders","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate","text":"Predicate","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":"> ","kind":"text"},{"text":"where","kind":"keyword"},{"text":" ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Fetchable","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Fetchable","preciseIdentifier":"s:12SafeFetching9FetchableP","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/safefetching\/!(_:)-1nel2"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"externalID":"s:12SafeFetching1nopyAA8BuildersO9PredicateCy_xGAgA9FetchableRzlF","roleHeading":"Operator","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!"},{"kind":"text","text":" "},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"E"},{"kind":"text","text":">("},{"kind":"typeIdentifier","text":"Builders","preciseIdentifier":"s:12SafeFetching8BuildersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Predicate","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC"},{"kind":"text","text":"<"},{"text":"E","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Builders","preciseIdentifier":"s:12SafeFetching8BuildersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Predicate","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"SafeFetching"}],"title":"!(_:)","symbolKind":"op"},"identifier":{"url":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/!(_:)-1nel2","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/SafeFetching\/documentation\/SafeFetching"]]},"references":{"doc://SafeFetching/documentation/SafeFetching/Builders/Predicate":{"identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate","title":"Builders.Predicate","abstract":[{"text":"Generated from ","type":"text"},{"identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/FetchableMember","isActive":true,"type":"reference"},{"text":" operations to wrap a ","type":"text"},{"code":"NSPredicate","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Predicate","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Predicate","kind":"identifier"}],"type":"topic","url":"\/documentation\/safefetching\/builders\/predicate"},"doc://SafeFetching/documentation/SafeFetching/Fetchable":{"kind":"symbol","abstract":[{"type":"text","text":"Implemented by a "},{"type":"codeVoice","code":"NSManagedObject"},{"type":"text","text":" to offer fetching using SafeFetching API."}],"url":"\/documentation\/safefetching\/fetchable","navigatorTitle":[{"text":"Fetchable","kind":"identifier"}],"type":"topic","role":"symbol","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Fetchable","title":"Fetchable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Fetchable","kind":"identifier"}]},"doc://SafeFetching/documentation/SafeFetching":{"abstract":[{"text":"Convenience functions around ","type":"text"},{"type":"codeVoice","code":"CoreData"},{"text":" fetching.","type":"text"}],"kind":"symbol","title":"SafeFetching","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching","type":"topic","url":"\/documentation\/safefetching","role":"collection"},"doc://SafeFetching/documentation/SafeFetching/!(_:)-1nel2":{"url":"\/documentation\/safefetching\/!(_:)-1nel2","kind":"symbol","role":"symbol","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/!(_:)-1nel2","title":"!(_:)","abstract":[],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!"},{"kind":"text","text":" "},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"E"},{"kind":"text","text":">("},{"kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO","text":"Builders"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","text":"Predicate"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO","text":"Builders"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","text":"Predicate"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}]},"doc://SafeFetching/documentation/SafeFetching/Builders":{"title":"Builders","role":"symbol","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders","url":"\/documentation\/safefetching\/builders","kind":"symbol","type":"topic","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Builders","kind":"identifier"}],"navigatorTitle":[{"text":"Builders","kind":"identifier"}],"abstract":[{"text":"Namespace to hide most building types used by SafeFetching to make requests.","type":"text"}]},"doc://SafeFetching/documentation/SafeFetching/FetchableMember":{"url":"\/documentation\/safefetching\/fetchablemember","navigatorTitle":[{"text":"FetchableMember","kind":"identifier"}],"abstract":[{"text":"Stores types and identifier of an entity and attribute or relationship that can be used for fetching.","type":"text"}],"identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/FetchableMember","title":"FetchableMember","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"FetchableMember","kind":"identifier"}],"kind":"symbol","type":"topic"}}}

0 commit comments

Comments
 (0)