IGListKit/Source/Common/IGListDiffable.h
Ryan Nystrom 8d8a632b67 Update MIT license language (#1272)
Summary:
Updating license language to meet FB open source standards.
Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1272

Differential Revision: D12844366

Pulled By: rnystrom

fbshipit-source-id: 27ae49ae00d963c5c012c79c5738365c232a5773
2018-11-01 10:58:46 -07:00

38 lines
1.1 KiB
Objective-C

/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#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