Functions

The following functions are available globally.


                    
                    
                    IGListDiff

Create a diff using indexes between two collections.

Declaration

Objective-C

extern IGListIndexSetResult *_Nonnull IGListDiff(
    NSArray<id<IGListDiffable>> *_Nullable oldArray,
    NSArray<id<IGListDiffable>> *_Nullable newArray, IGListDiffOption option)

Parameters

`oldArray`	The old objects to diff against.
`newArray`	The new objects to diff with.
`option`	An option on how to compare objects.

Return Value

Result object with effected indexes.


                    
                    
                    IGListDiffPaths

Create a diff using index paths between two collections.

Declaration

Objective-C

extern IGListIndexPathResult *_Nonnull IGListDiffPaths(
    NSInteger fromSection, NSInteger toSection,
    NSArray<id<IGListDiffable>> *_Nullable oldArray,
    NSArray<id<IGListDiffable>> *_Nullable newArray, IGListDiffOption option)

Parameters

`fromSection`	The old section used to seed returned index paths.
`toSection`	The new section used to seed returned index paths.
`oldArray`	The old objects to diff against.
`newArray`	The new objects to diff with.
`option`	An option on how to compare objects.

Return Value

Result object with effected index paths.


                    
                    
                    IGListExperimentEnabled

Check if an experiment is enabled in a bitmask.

Declaration

Objective-C

static inline BOOL IGListExperimentEnabled(IGListExperiment mask,
                                           IGListExperiment option)

Swift

func IGListExperimentEnabled(_ mask: IGListExperiment, _ option: IGListExperiment) -> Bool

Parameters

`mask`	The bitmask of experiments.
`option`	The option to compare with.

Return Value

YES if the option is in the bitmask, otherwise NO.


                    
                    
                    IGListDiffExperiment

Perform a diff with an experiment bitmask. See IGListDiff() in IGListDiff.h

Declaration

Objective-C

extern IGListIndexSetResult *_Nonnull IGListDiffExperiment(
    NSArray<id<IGListDiffable>> *_Nullable oldArray,
    NSArray<id<IGListDiffable>> *_Nullable newArray, IGListDiffOption option,
    IGListExperiment experiments)


                    
                    
                    IGListDiffPathsExperiment

Perform a diff with an experiment bitmask. See IGListDiffPaths() in IGListDiff.h

Declaration

Objective-C

extern IGListIndexPathResult *_Nonnull IGListDiffPathsExperiment(
    NSInteger fromSection, NSInteger toSection,
    NSArray<id<IGListDiffable>> *_Nullable oldArray,
    NSArray<id<IGListDiffable>> *_Nullable newArray, IGListDiffOption option,
    IGListExperiment experiments)