mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-11 03:20:55 +00:00
40625f8ff9
Summary: This adds `NS_SWIFT_NAME` annotations to all public API's to provide cleaner integration into Swift: - Removes the need to prefix classes in Swift code, instead rely on Swift module name spacing - Adds more argument labels to C function API's like `IGListDiff([], [], .equality)` => `ListDiff(oldArray: [], newArray: [], option: .equality)` While this is a large API change it should be as easy as: - Find and replace `(IGList)([^K])` to `List$2` in Xcode with a scope set to Swift - Build and follow compiler's auto fix corrections for C API's or any missed renames I have not updated the documentation to reflect this yet, I am totally willing to do so but before I sink that amount of time into it I wanted to see if the Instagram team is even open to this change! - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) - [ ] I have updated the documentation Closes https://github.com/Instagram/IGListKit/pull/593 Reviewed By: jessesquires Differential Revision: D5028039 Pulled By: rnystrom fbshipit-source-id: b473d874a1f9574e56b2ebaabd5b73d1b57d4bab
40 lines
1.2 KiB
Objective-C
40 lines
1.2 KiB
Objective-C
/**
|
|
* Copyright (c) 2016-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
/**
|
|
The `IGListDiffable` protocol provides methods needed to compare the identity and equality of two objects.
|
|
*/
|
|
NS_SWIFT_NAME(ListDiffable)
|
|
@protocol IGListDiffable
|
|
|
|
/**
|
|
Returns a key that uniquely identifies the object.
|
|
|
|
@return A key that can be used to uniquely identify the object.
|
|
|
|
@note Two objects may share the same identifier, but are not equal. A common pattern is to use the `NSObject`
|
|
category for automatic conformance. However this means that objects will be identified on their
|
|
pointer value so finding updates becomes impossible.
|
|
|
|
@warning This value should never be mutated.
|
|
*/
|
|
- (nonnull id<NSObject>)diffIdentifier;
|
|
|
|
/**
|
|
Returns whether the receiver and a given object are equal.
|
|
|
|
@param object The object to be compared to the receiver.
|
|
|
|
@return `YES` if the receiver and object are equal, otherwise `NO`.
|
|
*/
|
|
- (BOOL)isEqualToDiffableObject:(nullable id<IGListDiffable>)object;
|
|
|
|
@end
|