IGListKit/Source/IGListDiffKit/IGListIndexPathResult.h
Tim Oliver a1b9c2ddb3 Updated corporate branding in IGListKit source files
Summary:
A quick push to fix something I noticed while studying how IGListKit works. This simply replaces "Facebook, Inc" with "Meta Platforms, Inc" in all of the source files where the company copyright notice is posted. This should help bring our external facing projects more in line with our new corporate branding.

There's still a lot more references to "Facebook" as a company in the library (especially around linking to other Meta sponsored open source libraries), but this might need additional scrutiny and review on a case-by-case basis, so let's handle those ones separately.

Reviewed By: lorixx

Differential Revision: D41207363

fbshipit-source-id: 57cdbf5eb1023b41a5f32c0c05e01628686a19fe
2022-11-15 21:47:29 -08:00

85 lines
2.1 KiB
Objective-C

/*
* Copyright (c) Meta Platforms, 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>
#import "IGListMoveIndexPath.h"
NS_ASSUME_NONNULL_BEGIN
/**
A result object returned when diffing with sections.
*/
NS_SWIFT_NAME(ListIndexPathResult)
@interface IGListIndexPathResult : NSObject
/**
The index paths inserted into the new collection.
*/
@property (nonatomic, copy, readonly) NSArray<NSIndexPath *> *inserts;
/**
The index paths deleted from the old collection.
*/
@property (nonatomic, copy, readonly) NSArray<NSIndexPath *> *deletes;
/**
The index paths in the old collection that need updated.
*/
@property (nonatomic, copy, readonly) NSArray<NSIndexPath *> *updates;
/**
The moves from an index path in the old collection to an index path in the new collection.
*/
@property (nonatomic, copy, readonly) NSArray<IGListMoveIndexPath *> *moves;
/**
A Read-only boolean that indicates whether the result has any changes or not.
`YES` if the result has changes, `NO` otherwise.
*/
@property (nonatomic, assign, readonly) BOOL hasChanges;
/**
Returns the index path of the object with the specified identifier *before* the diff.
@param identifier The diff identifier of the object.
@return The index path of the object before the diff, or `nil`.
@see `-[IGListDiffable diffIdentifier]`.
*/
- (nullable NSIndexPath *)oldIndexPathForIdentifier:(id<NSObject>)identifier;
/**
Returns the index path of the object with the specified identifier *after* the diff.
@param identifier The diff identifier of the object.
@return The index path of the object after the diff, or `nil`.
@see `-[IGListDiffable diffIdentifier]`.
*/
- (nullable NSIndexPath *)newIndexPathForIdentifier:(id<NSObject>)identifier;
/**
Creates a new result object with operations safe for use in `UITableView` and `UICollectionView` batch updates.
*/
- (IGListIndexPathResult *)resultForBatchUpdates;
/**
:nodoc:
*/
- (instancetype)init NS_UNAVAILABLE;
/**
:nodoc:
*/
+ (instancetype)new NS_UNAVAILABLE;
@end
NS_ASSUME_NONNULL_END