Protocols

Objective-C Foundation types that are natively supported by Core Data managed attributes all conform to CoreDataNativeType.

Custom loggers should implement the CoreStoreLogger protocol and pass its instance to CoreStoreDefaults.logger. Calls to log(...), assert(...), and abort(...) are not tied to a specific queue/thread, so it is the implementer’s job to handle thread-safety.

Observation token for CoreStoreObject properties. Make sure to retain this instance to keep observing notifications.

invalidate() will be called automatically when an CoreStoreObjectKeyValueObservation is deinited.

All CoreStore’s utilities are designed around DynamicObject instances. NSManagedObject and CoreStoreObject instances all conform to DynamicObject.

The DiffableDataSource.Target protocol allows custom views to consume ListSnapshot diffable data similar to how DiffableDataSource.TableViewAdapter and DiffableDataSource.CollectionViewAdapter reloads data for their corresponding views.

DynamicSchema are types that provide NSManagedObjectModel instances for a single model version. CoreStore currently supports the following concrete types:

• XcodeDataModelSchema: describes models loaded from a .xcdatamodeld file.
• UnsafeDataModelSchema: describes models loaded directly from an existing NSManagedObjectModel. It is not advisable to continue using this model as its metadata are not available to CoreStore.
• CoreStoreSchema: describes models written for CoreStoreObject Swift class declarations.

Values to be used for Field.Relationship properties.

Utility protocol for FetchChainBuilder. Used in fetch methods that support chained fetch builders.

Encapsulates containers which manages an internal NSManagedObjectContext, such as DataStacks and transactions, that can be used for fetching objects. CoreStore provides implementations for this protocol and should be used as a read-only abstraction.

Types that implement encoding to and decoding from Data to be used in Field.Coded properties’ coder: argument.

class Person: CoreStoreObject {

    @Field.Coded("profile", coder: FieldCoders.Json.self)
    var profile: Profile = .init()
}

Types that are supported by FieldCoders.DefaultNSSecureCoding

Optional values to be used for Field properties.

Values to be used for Field.Stored properties.

Abstracts the GroupBy clause for protocol utilities.

Types supported by CoreStore as NSManagedObject and CoreStoreObject property types. Supported default types:

• Bool
• CGFloat
• Data

• Double
• Float
• Int
• Int8
• Int16
• Int32
• Int64
• NSData
• NSDate
• NSDecimalNumber
• NSNumber
• NSString
• NSURL
• NSUUID
• String
• URL
• UUID

In addition, RawRepresentable types whose RawValue already implements ImportableAttributeType only need to declare conformance to ImportableAttributeType.

NSManagedObject and CoreStoreObject subclasses that conform to the ImportableObject protocol can be imported from a specified ImportSource. This allows transactions to create and insert instances this way:

class Person: NSManagedObject, ImportableObject {
    typealias ImportSource = NSDictionary
    // ...
}

dataStack.perform(
    asynchronous: { (transaction) -> Void in
        let json: NSDictionary = // ...
        let person = try transaction.importObject(
            Into<Person>(),
            source: json
        )
        // ...
    },
    completion: { (result) in
        // ...
    }
)

NSManagedObject subclasses that conform to the ImportableUniqueObject protocol can be imported from a specified ImportSource. This allows transactions to either update existing objects or create new instances this way:

class Person: NSManagedObject, ImportableObject {
    typealias ImportSource = NSDictionary
    typealias UniqueIDType = NSString
    // ...
}

dataStack.perform(
    asynchronous: { (transaction) -> Void in
        let json: NSDictionary = // ...
        let person = try transaction.importUniqueObject(
            Into<Person>(),
            source: json
        )
        // ...
    },
    completion: { (result) in
        // ...
    }
)

Used only for utility methods. Types allowed as Value generic type to KeyPath utilities.

Used only for utility methods. Types allowed as Value generic type to KeyPath utilities.

Used only for utility methods. Types allowed as Value generic type to KeyPath utilities.

Used only for utility methods. Types allowed as Value generic type to KeyPath utilities.

Used only for utility methods. Types allowed as Value generic type to KeyPath utilities.

Used only for utility methods.

Used only for utility methods.

Used only for utility methods.

Used only for utility methods.

Implement the ListObserver protocol to observe changes to a list of NSManagedObjects. ListObservers may register themselves to a ListMonitor‘s addObserver(_:) method:

let monitor = dataStack.monitorList(
    From<Person>(),
    OrderBy(.ascending("lastName"))
)
monitor.addObserver(self)

Implement the ListObjectObserver protocol to observe detailed changes to a list’s object. ListObjectObservers may register themselves to a ListMonitor‘s addObserver(_:) method:

let monitor = dataStack.monitorList(
    From<MyPersonEntity>(),
    OrderBy(.ascending("lastName"))
)
monitor.addObserver(self)

Implement the ListSectionObserver protocol to observe changes to a list’s section info. ListSectionObservers may register themselves to a ListMonitor‘s addObserver(_:) method:

let monitor = dataStack.monitorSectionedList(
    From<MyPersonEntity>(),
    SectionBy("age") { "Age \($0)" },
    OrderBy(.ascending("lastName"))
)
monitor.addObserver(self)

Implement the ObjectObserver protocol to observe changes to a single DynamicObject instance. ObjectObservers may register themselves to an ObjectMonitor‘s addObserver(_:) method:

let monitor = dataStack.monitorObject(object)
monitor.addObserver(self)

Used internally by CoreStore. Do not conform to directly.

An object that acts as interfaces for CoreStoreObjects or NSManagedObjects

Abstracts the OrderBy clause for protocol utilities.

Utility protocol for QueryChainBuilder. Used in fetch methods that support chained query builders.

Types supported by CoreStore for querying, especially as generic type for Select clauses. Supported default types:

• Bool
• CGFloat
• Data
• Date
• Double
• Float
• Int
• Int8
• Int16
• Int32
• Int64
• NSData
• NSDate
• NSDecimalNumber
• NSManagedObjectID
• NSNull
• NSNumber
• NSString
• NSURL
• NSUUID
• String
• URL
• UUID

In addition, RawRepresentable types whose RawValue already implements QueryableAttributeType only need to declare conformance to QueryableAttributeType.

Encapsulates containers which manages an internal NSManagedObjectContext, such as DataStacks and transactions, that can be used for querying values. CoreStore provides implementations for this protocol and should be used as a read-only abstraction.

The SchemaMappingProvider provides migration mapping information between two DynamicSchema versions.

Utility protocol for SectionMonitorChainBuilder. Used in methods that support chained fetch builders.

The SelectResultType protocol is implemented by return types supported by the Select clause.

The SelectAttributesResultType protocol is implemented by return types supported by the queryAttributes(...) methods.

Abstracts the Select clause for protocol utilities.

The StorageInterface represents the data store managed (or to be managed) by the DataStack. When added to the DataStack, the StorageInterface serves as the interface for the NSPersistentStore. This may be a database file, an in-memory store, etc.

The LocalStorage represents StorageInterfaces that are backed by local files.

The FetchClause implement clauses used to configure NSFetchRequests.

The QueryClause implement clauses used to configure NSFetchRequests.

The DeleteClause implement clauses used to configure NSFetchRequests.

Type-erased Where clause for protocol utilities.

Used only for Where.Expression type constraints. Currently supports SingleTarget and CollectionTarget.

Abstracts the Where clause for protocol utilities. Typically used only for utility method generic constraints.