IGListKit/Source/IGListDiffKit/IGListDiff.h
Tim Oliver f92b9339ee Standarize the copyright notice in all source files
Summary:
The standardized Meta copyright notice is "Copyright (c) Meta Platforms, Inc. and affiliates." and not "Copyright (c) Meta Platforms, Inc. and its affiliates." (Dropping the "its")

This diff updates the copyright notice in each source file to the correct this.

Reviewed By: willbailey

Differential Revision: D44737667

fbshipit-source-id: 643bf36df76723e70d9d826c53cf8f29b8a0c8cc
2023-04-06 02:44:16 -07:00

63 lines
2.1 KiB
Objective-C

/*
* Copyright (c) Meta Platforms, Inc. and 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 "IGListDiffable.h"
#import "IGListIndexPathResult.h"
#import "IGListIndexSetResult.h"
NS_ASSUME_NONNULL_BEGIN
/**
An option for how to do comparisons between similar objects.
*/
NS_SWIFT_NAME(ListDiffOption)
typedef NS_ENUM(NSInteger, IGListDiffOption) {
/**
Compare objects using pointer personality.
*/
IGListDiffPointerPersonality,
/**
Compare objects using `-[IGListDiffable isEqualToDiffableObject:]`.
*/
IGListDiffEquality
};
/**
Creates a diff using indexes between two collections.
@param oldArray The old objects to diff against.
@param newArray The new objects.
@param option An option on how to compare objects.
@return A result object containing affected indexes.
*/
NS_SWIFT_NAME(ListDiff(oldArray:newArray:option:))
FOUNDATION_EXTERN IGListIndexSetResult *IGListDiff(NSArray<id<IGListDiffable>> *_Nullable oldArray,
NSArray<id<IGListDiffable>> *_Nullable newArray,
IGListDiffOption option);
/**
Creates a diff using index paths between two collections.
@param fromSection The old section.
@param toSection The new section.
@param oldArray The old objects to diff against.
@param newArray The new objects.
@param option An option on how to compare objects.
@return A result object containing affected indexes.
*/
NS_SWIFT_NAME(ListDiffPaths(fromSection:toSection:oldArray:newArray:option:))
FOUNDATION_EXTERN IGListIndexPathResult *IGListDiffPaths(NSInteger fromSection,
NSInteger toSection,
NSArray<id<IGListDiffable>> *_Nullable oldArray,
NSArray<id<IGListDiffable>> *_Nullable newArray,
IGListDiffOption option);
NS_ASSUME_NONNULL_END