xref: /third_party/protobuf/objectivec/GPBArray.h

62  * @param value The value to be placed in the array.
64  * @return A newly instanced GPBInt32Array with value in it.
66 + (instancetype)arrayWithValue:(int32_t)value;
122  * Gets the value at the given index.
124  * @param index The index of the value to get.
126  * @return The value at the given index.
134  *   **value**: The current value being enumerated.
135  *   **idx**:   The index of the current value.
138 - (void)enumerateValuesWithBlock:(void (NS_NOESCAPE ^)(int32_t value, NSUInteger idx, BOOL *stop))block;
145  *   **value**: The current value being enumerated.
146  *   **idx**:   The index of the current value.
150                         usingBlock:(void (NS_NOESCAPE ^)(int32_t value, NSUInteger idx, BOOL *stop))block;
153  * Adds a value to this array.
155  * @param value The value to add to this array.
157 - (void)addValue:(int32_t)value;
175  * Inserts a value into the given position.
177  * @param value The value to add to this array.
178  * @param index The index into which to insert the value.
180 - (void)insertValue:(int32_t)value atIndex:(NSUInteger)index;
183  * Replaces the value at the given index with the given value.
185  * @param index The index for which to replace the value.
186  * @param value The value to replace with.
188 - (void)replaceValueAtIndex:(NSUInteger)index withValue:(int32_t)value;
191  * Removes the value at the given index.
193  * @param index The index of the value to remove.
234  * @param value The value to be placed in the array.
236  * @return A newly instanced GPBUInt32Array with value in it.
238 + (instancetype)arrayWithValue:(uint32_t)value;
294  * Gets the value at the given index.
296  * @param index The index of the value to get.
298  * @return The value at the given index.
306  *   **value**: The current value being enumerated.
307  *   **idx**:   The index of the current value.
310 - (void)enumerateValuesWithBlock:(void (NS_NOESCAPE ^)(uint32_t value, NSUInteger idx, BOOL *stop))block;
317  *   **value**: The current value being enumerated.
318  *   **idx**:   The index of the current value.
322                         usingBlock:(void (NS_NOESCAPE ^)(uint32_t value, NSUInteger idx, BOOL *stop))block;
325  * Adds a value to this array.
327  * @param value The value to add to this array.
329 - (void)addValue:(uint32_t)value;
347  * Inserts a value into the given position.
349  * @param value The value to add to this array.
350  * @param index The index into which to insert the value.
352 - (void)insertValue:(uint32_t)value atIndex:(NSUInteger)index;
355  * Replaces the value at the given index with the given value.
357  * @param index The index for which to replace the value.
358  * @param value The value to replace with.
360 - (void)replaceValueAtIndex:(NSUInteger)index withValue:(uint32_t)value;
363  * Removes the value at the given index.
365  * @param index The index of the value to remove.
406  * @param value The value to be placed in the array.
408  * @return A newly instanced GPBInt64Array with value in it.
410 + (instancetype)arrayWithValue:(int64_t)value;
466  * Gets the value at the given index.
468  * @param index The index of the value to get.
470  * @return The value at the given index.
478  *   **value**: The current value being enumerated.
479  *   **idx**:   The index of the current value.
482 - (void)enumerateValuesWithBlock:(void (NS_NOESCAPE ^)(int64_t value, NSUInteger idx, BOOL *stop))block;
489  *   **value**: The current value being enumerated.
490  *   **idx**:   The index of the current value.
494                         usingBlock:(void (NS_NOESCAPE ^)(int64_t value, NSUInteger idx, BOOL *stop))block;
497  * Adds a value to this array.
499  * @param value The value to add to this array.
501 - (void)addValue:(int64_t)value;
519  * Inserts a value into the given position.
521  * @param value The value to add to this array.
522  * @param index The index into which to insert the value.
524 - (void)insertValue:(int64_t)value atIndex:(NSUInteger)index;
527  * Replaces the value at the given index with the given value.
529  * @param index The index for which to replace the value.
530  * @param value The value to replace with.
532 - (void)replaceValueAtIndex:(NSUInteger)index withValue:(int64_t)value;
535  * Removes the value at the given index.
537  * @param index The index of the value to remove.
578  * @param value The value to be placed in the array.
580  * @return A newly instanced GPBUInt64Array with value in it.
582 + (instancetype)arrayWithValue:(uint64_t)value;
638  * Gets the value at the given index.
640  * @param index The index of the value to get.
642  * @return The value at the given index.
650  *   **value**: The current value being enumerated.
651  *   **idx**:   The index of the current value.
654 - (void)enumerateValuesWithBlock:(void (NS_NOESCAPE ^)(uint64_t value, NSUInteger idx, BOOL *stop))block;
661  *   **value**: The current value being enumerated.
662  *   **idx**:   The index of the current value.
666                         usingBlock:(void (NS_NOESCAPE ^)(uint64_t value, NSUInteger idx, BOOL *stop))block;
669  * Adds a value to this array.
671  * @param value The value to add to this array.
673 - (void)addValue:(uint64_t)value;
691  * Inserts a value into the given position.
693  * @param value The value to add to this array.
694  * @param index The index into which to insert the value.
696 - (void)insertValue:(uint64_t)value atIndex:(NSUInteger)index;
699  * Replaces the value at the given index with the given value.
701  * @param index The index for which to replace the value.
702  * @param value The value to replace with.
704 - (void)replaceValueAtIndex:(NSUInteger)index withValue:(uint64_t)value;
707  * Removes the value at the given index.
709  * @param index The index of the value to remove.
750  * @param value The value to be placed in the array.
752  * @return A newly instanced GPBFloatArray with value in it.
754 + (instancetype)arrayWithValue:(float)value;
810  * Gets the value at the given index.
812  * @param index The index of the value to get.
814  * @return The value at the given index.
822  *   **value**: The current value being enumerated.
823  *   **idx**:   The index of the current value.
826 - (void)enumerateValuesWithBlock:(void (NS_NOESCAPE ^)(float value, NSUInteger idx, BOOL *stop))block;
833  *   **value**: The current value being enumerated.
834  *   **idx**:   The index of the current value.
838                         usingBlock:(void (NS_NOESCAPE ^)(float value, NSUInteger idx, BOOL *stop))block;
841  * Adds a value to this array.
843  * @param value The value to add to this array.
845 - (void)addValue:(float)value;
863  * Inserts a value into the given position.
865  * @param value The value to add to this array.
866  * @param index The index into which to insert the value.
868 - (void)insertValue:(float)value atIndex:(NSUInteger)index;
871  * Replaces the value at the given index with the given value.
873  * @param index The index for which to replace the value.
874  * @param value The value to replace with.
876 - (void)replaceValueAtIndex:(NSUInteger)index withValue:(float)value;
879  * Removes the value at the given index.
881  * @param index The index of the value to remove.
922  * @param value The value to be placed in the array.
924  * @return A newly instanced GPBDoubleArray with value in it.
926 + (instancetype)arrayWithValue:(double)value;
982  * Gets the value at the given index.
984  * @param index The index of the value to get.
986  * @return The value at the given index.
994  *   **value**: The current value being enumerated.
995  *   **idx**:   The index of the current value.
998 - (void)enumerateValuesWithBlock:(void (NS_NOESCAPE ^)(double value, NSUInteger idx, BOOL *stop))block;
1005  *   **value**: The current value being enumerated.
1006  *   **idx**:   The index of the current value.
1010                         usingBlock:(void (NS_NOESCAPE ^)(double value, NSUInteger idx, BOOL *stop))block;
1013  * Adds a value to this array.
1015  * @param value The value to add to this array.
1017 - (void)addValue:(double)value;
1035  * Inserts a value into the given position.
1037  * @param value The value to add to this array.
1038  * @param index The index into which to insert the value.
1040 - (void)insertValue:(double)value atIndex:(NSUInteger)index;
1043  * Replaces the value at the given index with the given value.
1045  * @param index The index for which to replace the value.
1046  * @param value The value to replace with.
1048 - (void)replaceValueAtIndex:(NSUInteger)index withValue:(double)value;
1051  * Removes the value at the given index.
1053  * @param index The index of the value to remove.
1094  * @param value The value to be placed in the array.
1096  * @return A newly instanced GPBBoolArray with value in it.
1098 + (instancetype)arrayWithValue:(BOOL)value;
1154  * Gets the value at the given index.
1156  * @param index The index of the value to get.
1158  * @return The value at the given index.
1166  *   **value**: The current value being enumerated.
1167  *   **idx**:   The index of the current value.
1170 - (void)enumerateValuesWithBlock:(void (NS_NOESCAPE ^)(BOOL value, NSUInteger idx, BOOL *stop))block;
1177  *   **value**: The current value being enumerated.
1178  *   **idx**:   The index of the current value.
1182                         usingBlock:(void (NS_NOESCAPE ^)(BOOL value, NSUInteger idx, BOOL *stop))block;
1185  * Adds a value to this array.
1187  * @param value The value to add to this array.
1189 - (void)addValue:(BOOL)value;
1207  * Inserts a value into the given position.
1209  * @param value The value to add to this array.
1210  * @param index The index into which to insert the value.
1212 - (void)insertValue:(BOOL)value atIndex:(NSUInteger)index;
1215  * Replaces the value at the given index with the given value.
1217  * @param index The index for which to replace the value.
1218  * @param value The value to replace with.
1220 - (void)replaceValueAtIndex:(NSUInteger)index withValue:(BOOL)value;
1223  * Removes the value at the given index.
1225  * @param index The index of the value to remove.
1277  * given and the single raw value given.
1280  * @param value The raw value to add to this array.
1285                                    rawValue:(int32_t)value;
1352 // These will return kGPBUnrecognizedEnumeratorValue if the value at index is not a
1353 // valid enumerator as defined by validationFunc. If the actual value is
1357  * Gets the value at the given index.
1359  * @param index The index of the value to get.
1361  * @return The value at the given index.
1369  *   **value**: The current value being enumerated.
1370  *   **idx**:   The index of the current value.
1373 - (void)enumerateValuesWithBlock:(void (NS_NOESCAPE ^)(int32_t value, NSUInteger idx, BOOL *stop))block;
1380  *   **value**: The current value being enumerated.
1381  *   **idx**:   The index of the current value.
1385                         usingBlock:(void (NS_NOESCAPE ^)(int32_t value, NSUInteger idx, BOOL *stop))block;
1391  * Gets the raw enum value at the given index.
1393  * @param index The index of the raw enum value to get.
1395  * @return The raw enum value at the given index.
1403  *   **value**: The current value being enumerated.
1404  *   **idx**:   The index of the current value.
1407 - (void)enumerateRawValuesWithBlock:(void (NS_NOESCAPE ^)(int32_t value, NSUInteger idx, BOOL *stop))block;
1414  *   **value**: The current value being enumerated.
1415  *   **idx**:   The index of the current value.
1419                            usingBlock:(void (NS_NOESCAPE ^)(int32_t value, NSUInteger idx, BOOL *stop))block;
1421 // If value is not a valid enumerator as defined by validationFunc, these
1422 // methods will assert in debug, and will log in release and assign the value
1423 // to the default value. Use the rawValue methods below to assign non enumerator
1427  * Adds a value to this array.
1429  * @param value The value to add to this array.
1431 - (void)addValue:(int32_t)value;
1443  * Inserts a value into the given position.
1445  * @param value The value to add to this array.
1446  * @param index The index into which to insert the value.
1448 - (void)insertValue:(int32_t)value atIndex:(NSUInteger)index;
1451  * Replaces the value at the given index with the given value.
1453  * @param index The index for which to replace the value.
1454  * @param value The value to replace with.
1456 - (void)replaceValueAtIndex:(NSUInteger)index withValue:(int32_t)value;
1462  * Adds a raw enum value to this array.
1467  * @param value The raw enum value to add to the array.
1469 - (void)addRawValue:(int32_t)value;
1493  * Inserts a raw enum value at the given index.
1498  * @param value Raw enum value to add.
1499  * @param index The index into which to insert the value.
1501 - (void)insertRawValue:(int32_t)value atIndex:(NSUInteger)index;
1504  * Replaces the raw enum value at the given index with the given value.
1509  * @param index The index for which to replace the value.
1510  * @param value The raw enum value to replace with.
1512 - (void)replaceValueAtIndex:(NSUInteger)index withRawValue:(int32_t)value;
1517  * Removes the value at the given index.
1519  * @param index The index of the value to remove.
1580 //% * @param value The value to be placed in the array.
1582 //% * @return A newly instanced GPB##NAME##Array with value in it.
1584 //%+ (instancetype)arrayWithValue:(TYPE)value;
1683 //% * given and the single raw value given.
1686 //% * @param value The raw value to add to this array.
1691 //%                                   rawValue:(TYPE)value;
1758 //%// These will return kGPBUnrecognizedEnumeratorValue if the value at index is not a
1759 //%// valid enumerator as defined by validationFunc. If the actual value is
1768 //% * Gets the raw enum value at the given index.
1770 //% * @param index The index of the raw enum value to get.
1772 //% * @return The raw enum value at the given index.
1780 //% *   **value**: The current value being enumerated.
1781 //% *   **idx**:   The index of the current value.
1784 //%- (void)enumerateRawValuesWithBlock:(void (NS_NOESCAPE ^)(TYPE value, NSUInteger idx, BOOL *stop))block;
1791 //% *   **value**: The current value being enumerated.
1792 //% *   **idx**:   The index of the current value.
1796 //%                           usingBlock:(void (NS_NOESCAPE ^)(TYPE value, NSUInteger idx, BOOL *stop))block;
1798 //%// If value is not a valid enumerator as defined by validationFunc, these
1799 //%// methods will assert in debug, and will log in release and assign the value
1800 //%// to the default value. Use the rawValue methods below to assign non enumerator
1810 //% * Gets the value at the given index.
1812 //% * @param index The index of the value to get.
1814 //% * @return The value at the given index.
1822 //% *   **value**: The current value being enumerated.
1823 //% *   **idx**:   The index of the current value.
1826 //%- (void)enumerateValuesWithBlock:(void (NS_NOESCAPE ^)(TYPE value, NSUInteger idx, BOOL *stop))block;
1833 //% *   **value**: The current value being enumerated.
1834 //% *   **idx**:   The index of the current value.
1838 //%                        usingBlock:(void (NS_NOESCAPE ^)(TYPE value, NSUInteger idx, BOOL *stop))block;
1842 //% * Adds a value to this array.
1844 //% * @param value The value to add to this array.
1846 //%- (void)addValue:(TYPE)value;
1858 //% * Inserts a value into the given position.
1860 //% * @param value The value to add to this array.
1861 //% * @param index The index into which to insert the value.
1863 //%- (void)insertValue:(TYPE)value atIndex:(NSUInteger)index;
1866 //% * Replaces the value at the given index with the given value.
1868 //% * @param index The index for which to replace the value.
1869 //% * @param value The value to replace with.
1871 //%- (void)replaceValueAtIndex:(NSUInteger)index withValue:(TYPE)value;
1874 //% * Removes the value at the given index.
1876 //% * @param index The index of the value to remove.
1916 //% * Adds a raw enum value to this array.
1921 //% * @param value The raw enum value to add to the array.
1923 //%- (void)addRawValue:(TYPE)value;
1947 //% * Inserts a raw enum value at the given index.
1952 //% * @param value Raw enum value to add.
1953 //% * @param index The index into which to insert the value.
1955 //%- (void)insertRawValue:(TYPE)value atIndex:(NSUInteger)index;
1958 //% * Replaces the raw enum value at the given index with the given value.
1963 //% * @param index The index for which to replace the value.
1964 //% * @param value The raw enum value to replace with.
1966 //%- (void)replaceValueAtIndex:(NSUInteger)index withRawValue:(TYPE)value;

Indexes created Thu Nov 07 10:32:03 CST 2024