#import <GPBArray.h>
Inheritance diagram for GPBEnumArray:
Class Methods | |
| (instancetype) | + array |
| (instancetype) | + array |
| (instancetype) | + arrayWithValidationFunction: |
| (instancetype) | + arrayWithValidationFunction: |
| (instancetype) | + arrayWithValidationFunction:capacity: |
| (instancetype) | + arrayWithValidationFunction:capacity: |
| (instancetype) | + arrayWithValidationFunction:rawValue: |
| (instancetype) | + arrayWithValidationFunction:rawValue: |
| (instancetype) | + arrayWithValueArray: |
| (instancetype) | + arrayWithValueArray: |
Protected Attributes | |
| package GPB_UNSAFE_UNRETAINED GPBMessage * | _autocreator |
Properties | |
| NSUInteger | count |
| GPBEnumValidationFunc | validationFunc |
Detailed Description
This class is used for repeated fields of int32_t values. This performs better than boxing into NSNumbers in NSArrays.
- Note
- This class is not meant to be subclassed.
Definition at line 1252 of file bloaty/third_party/protobuf/objectivec/GPBArray.h.
Method Documentation
◆ addRawValue: [1/2]
| - (void) addRawValue: | (int32_t) | value |
Adds a raw enum value to this array.
- Note
- This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
- Parameters
-
value The raw enum value to add to the array.
◆ addRawValue: [2/2]
| - (void) addRawValue: | (int32_t) | value |
Adds a raw enum value to this array.
- Note
- This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
- Parameters
-
value The raw enum value to add to the array.
◆ addRawValues:count: [1/2]
Adds raw enum values to this array.
- Note
- This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
- Parameters
-
values Array containing the raw enum values to add to this array. count The number of raw values to add.
◆ addRawValues:count: [2/2]
Adds raw enum values to this array.
- Note
- This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
- Parameters
-
values Array containing the raw enum values to add to this array. count The number of raw values to add.
◆ addRawValuesFromArray: [1/2]
| - (void) addRawValuesFromArray: | (GPBEnumArray *) | array |
Adds raw enum values to this array.
- Note
- This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
- Parameters
-
array Array containing the raw enum values to add to this array.
◆ addRawValuesFromArray: [2/2]
| - (void) addRawValuesFromArray: | (GPBEnumArray *) | array |
Adds raw enum values to this array.
- Note
- This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
- Parameters
-
array Array containing the raw enum values to add to this array.
◆ addValue: [1/2]
| - (void) addValue: | (int32_t) | value |
Adds a value to this array.
- Parameters
-
value The value to add to this array.
◆ addValue: [2/2]
| - (void) addValue: | (int32_t) | value |
Adds a value to this array.
- Parameters
-
value The value to add to this array.
◆ addValues:count: [1/2]
Adds values to this array.
- Parameters
-
values The values to add to this array. count The number of elements to add.
◆ addValues:count: [2/2]
Adds values to this array.
- Parameters
-
values The values to add to this array. count The number of elements to add.
◆ array [1/2]
| + (instancetype) array |
- Returns
- A newly instanced and empty GPBEnumArray.
◆ array [2/2]
| + (instancetype) array |
- Returns
- A newly instanced and empty GPBEnumArray.
◆ arrayWithValidationFunction: [1/2]
| + (instancetype) arrayWithValidationFunction: | (nullable GPBEnumValidationFunc) | func |
Creates and initializes a GPBEnumArray with the enum validation function given.
- Parameters
-
func The enum validation function for the array.
- Returns
- A newly instanced GPBEnumArray.
◆ arrayWithValidationFunction: [2/2]
| + (instancetype) arrayWithValidationFunction: | (nullable GPBEnumValidationFunc) | func |
Creates and initializes a GPBEnumArray with the enum validation function given.
- Parameters
-
func The enum validation function for the array.
- Returns
- A newly instanced GPBEnumArray.
◆ arrayWithValidationFunction:capacity: [1/2]
| + (instancetype) arrayWithValidationFunction: | (nullable GPBEnumValidationFunc) | func | |
| capacity: | (NSUInteger) | count | |
Creates and initializes a GPBEnumArray with the given enum validation function and with the givencapacity.
- Parameters
-
func The enum validation function for the array. count The capacity needed for the array.
- Returns
- A newly instanced GPBEnumArray with a capacity of count.
◆ arrayWithValidationFunction:capacity: [2/2]
| + (instancetype) arrayWithValidationFunction: | (nullable GPBEnumValidationFunc) | func | |
| capacity: | (NSUInteger) | count | |
Creates and initializes a GPBEnumArray with the given enum validation function and with the givencapacity.
- Parameters
-
func The enum validation function for the array. count The capacity needed for the array.
- Returns
- A newly instanced GPBEnumArray with a capacity of count.
◆ arrayWithValidationFunction:rawValue: [1/2]
| + (instancetype) arrayWithValidationFunction: | (nullable GPBEnumValidationFunc) | func | |
| rawValue: | (int32_t) | value | |
Creates and initializes a GPBEnumArray with the enum validation function given and the single raw value given.
- Parameters
-
func The enum validation function for the array. value The raw value to add to this array.
- Returns
- A newly instanced GPBEnumArray.
◆ arrayWithValidationFunction:rawValue: [2/2]
| + (instancetype) arrayWithValidationFunction: | (nullable GPBEnumValidationFunc) | func | |
| rawValue: | (int32_t) | value | |
Creates and initializes a GPBEnumArray with the enum validation function given and the single raw value given.
- Parameters
-
func The enum validation function for the array. value The raw value to add to this array.
- Returns
- A newly instanced GPBEnumArray.
◆ arrayWithValueArray: [1/2]
| + (instancetype) arrayWithValueArray: | (GPBEnumArray *) | array |
Creates and initializes a GPBEnumArray that adds the elements from the given array.
- Parameters
-
array Array containing the values to add to the new array.
- Returns
- A newly instanced GPBEnumArray.
◆ arrayWithValueArray: [2/2]
| + (instancetype) arrayWithValueArray: | (GPBEnumArray *) | array |
Creates and initializes a GPBEnumArray that adds the elements from the given array.
- Parameters
-
array Array containing the values to add to the new array.
- Returns
- A newly instanced GPBEnumArray.
◆ enumerateRawValuesWithBlock: [1/2]
| - (void) enumerateRawValuesWithBlock: | (void(NS_NOESCAPE ^ block)(int32_t value, NSUInteger idx, BOOL *stop)) |
Enumerates the values on this array with the given block.
- Parameters
-
block The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.
◆ enumerateRawValuesWithBlock: [2/2]
| - (void) enumerateRawValuesWithBlock: | (void(NS_NOESCAPE ^ block)(int32_t value, NSUInteger idx, BOOL *stop)) |
Enumerates the values on this array with the given block.
- Parameters
-
block The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.
◆ enumerateRawValuesWithOptions:usingBlock: [1/2]
| - (void) enumerateRawValuesWithOptions: | (NSEnumerationOptions) | opts | |
| usingBlock: | (void(NS_NOESCAPE ^ block)(int32_t value, NSUInteger idx, BOOL *stop)) | ||
Enumerates the values on this array with the given block.
- Parameters
-
opts Options to control the enumeration. block The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.
◆ enumerateRawValuesWithOptions:usingBlock: [2/2]
| - (void) enumerateRawValuesWithOptions: | (NSEnumerationOptions) | opts | |
| usingBlock: | (void(NS_NOESCAPE ^ block)(int32_t value, NSUInteger idx, BOOL *stop)) | ||
Enumerates the values on this array with the given block.
- Parameters
-
opts Options to control the enumeration. block The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.
◆ enumerateValuesWithBlock: [1/2]
| - (void) enumerateValuesWithBlock: | (void(NS_NOESCAPE ^ block)(int32_t value, NSUInteger idx, BOOL *stop)) |
Enumerates the values on this array with the given block.
- Parameters
-
block The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.
◆ enumerateValuesWithBlock: [2/2]
| - (void) enumerateValuesWithBlock: | (void(NS_NOESCAPE ^ block)(int32_t value, NSUInteger idx, BOOL *stop)) |
Enumerates the values on this array with the given block.
- Parameters
-
block The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.
◆ enumerateValuesWithOptions:usingBlock: [1/2]
| - (void) enumerateValuesWithOptions: | (NSEnumerationOptions) | opts | |
| usingBlock: | (void(NS_NOESCAPE ^ block)(int32_t value, NSUInteger idx, BOOL *stop)) | ||
Enumerates the values on this array with the given block.
- Parameters
-
opts Options to control the enumeration. block The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.
◆ enumerateValuesWithOptions:usingBlock: [2/2]
| - (void) enumerateValuesWithOptions: | (NSEnumerationOptions) | opts | |
| usingBlock: | (void(NS_NOESCAPE ^ block)(int32_t value, NSUInteger idx, BOOL *stop)) | ||
Enumerates the values on this array with the given block.
- Parameters
-
opts Options to control the enumeration. block The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.
◆ exchangeValueAtIndex:withValueAtIndex: [1/2]
| - (void) exchangeValueAtIndex: | (NSUInteger) | idx1 | |
| withValueAtIndex: | (NSUInteger) | idx2 | |
Exchanges the values between the given indexes.
- Parameters
-
idx1 The index of the first element to exchange. idx2 The index of the second element to exchange.
◆ exchangeValueAtIndex:withValueAtIndex: [2/2]
| - (void) exchangeValueAtIndex: | (NSUInteger) | idx1 | |
| withValueAtIndex: | (NSUInteger) | idx2 | |
Exchanges the values between the given indexes.
- Parameters
-
idx1 The index of the first element to exchange. idx2 The index of the second element to exchange.
◆ initWithValidationFunction: [1/2]
| - (instancetype) initWithValidationFunction: | (nullable GPBEnumValidationFunc) | NS_DESIGNATED_INITIALIZER |
Initializes the array with the given enum validation function.
- Parameters
-
func The enum validation function for the array.
- Returns
- A newly initialized GPBEnumArray with a copy of the values.
◆ initWithValidationFunction: [2/2]
| - (instancetype) initWithValidationFunction: | (nullable GPBEnumValidationFunc) | NS_DESIGNATED_INITIALIZER |
Initializes the array with the given enum validation function.
- Parameters
-
func The enum validation function for the array.
- Returns
- A newly initialized GPBEnumArray with a copy of the values.
◆ initWithValidationFunction:capacity: [1/2]
| - (instancetype) initWithValidationFunction: | (nullable GPBEnumValidationFunc) | func | |
| capacity: | (NSUInteger) | count | |
Initializes the array with the given capacity.
- Parameters
-
func The enum validation function for the array. count The capacity needed for the array.
- Returns
- A newly initialized GPBEnumArray with a capacity of count.
◆ initWithValidationFunction:capacity: [2/2]
| - (instancetype) initWithValidationFunction: | (nullable GPBEnumValidationFunc) | func | |
| capacity: | (NSUInteger) | count | |
Initializes the array with the given capacity.
- Parameters
-
func The enum validation function for the array. count The capacity needed for the array.
- Returns
- A newly initialized GPBEnumArray with a capacity of count.
◆ initWithValidationFunction:rawValues:count: [1/2]
| - (instancetype) initWithValidationFunction: | (nullable GPBEnumValidationFunc) | func | |
| rawValues: | (const int32_t) | values[__nullable] | |
| count: | (NSUInteger) | count | |
Initializes the array, copying the given values.
- Parameters
-
func The enum validation function for the array. values An array with the values to put inside this array. count The number of elements to copy into the array.
- Returns
- A newly initialized GPBEnumArray with a copy of the values.
◆ initWithValidationFunction:rawValues:count: [2/2]
| - (instancetype) initWithValidationFunction: | (nullable GPBEnumValidationFunc) | func | |
| rawValues: | (const int32_t) | values[__nullable] | |
| count: | (NSUInteger) | count | |
Initializes the array, copying the given values.
- Parameters
-
func The enum validation function for the array. values An array with the values to put inside this array. count The number of elements to copy into the array.
- Returns
- A newly initialized GPBEnumArray with a copy of the values.
◆ initWithValueArray: [1/2]
| - (instancetype) initWithValueArray: | (GPBEnumArray *) | array |
Initializes the array, copying the given values.
- Parameters
-
array An array with the values to put inside this array.
- Returns
- A newly initialized GPBEnumArray with a copy of the values.
◆ initWithValueArray: [2/2]
| - (instancetype) initWithValueArray: | (GPBEnumArray *) | array |
Initializes the array, copying the given values.
- Parameters
-
array An array with the values to put inside this array.
- Returns
- A newly initialized GPBEnumArray with a copy of the values.
◆ insertRawValue:atIndex: [1/2]
| - (void) insertRawValue: | (int32_t) | value | |
| atIndex: | (NSUInteger) | index | |
Inserts a raw enum value at the given index.
- Note
- This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
- Parameters
-
value Raw enum value to add. index The index into which to insert the value.
◆ insertRawValue:atIndex: [2/2]
| - (void) insertRawValue: | (int32_t) | value | |
| atIndex: | (NSUInteger) | index | |
Inserts a raw enum value at the given index.
- Note
- This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
- Parameters
-
value Raw enum value to add. index The index into which to insert the value.
◆ insertValue:atIndex: [1/2]
| - (void) insertValue: | (int32_t) | value | |
| atIndex: | (NSUInteger) | index | |
Inserts a value into the given position.
- Parameters
-
value The value to add to this array. index The index into which to insert the value.
◆ insertValue:atIndex: [2/2]
| - (void) insertValue: | (int32_t) | value | |
| atIndex: | (NSUInteger) | index | |
Inserts a value into the given position.
- Parameters
-
value The value to add to this array. index The index into which to insert the value.
◆ rawValueAtIndex: [1/2]
| - (int32_t) rawValueAtIndex: | (NSUInteger) | index |
Gets the raw enum value at the given index.
- Parameters
-
index The index of the raw enum value to get.
- Returns
- The raw enum value at the given index.
◆ rawValueAtIndex: [2/2]
| - (int32_t) rawValueAtIndex: | (NSUInteger) | index |
Gets the raw enum value at the given index.
- Parameters
-
index The index of the raw enum value to get.
- Returns
- The raw enum value at the given index.
◆ removeAll [1/2]
| - (void) removeAll |
Removes all the values from this array.
◆ removeAll [2/2]
| - (void) removeAll |
Removes all the values from this array.
◆ removeValueAtIndex: [1/2]
| - (void) removeValueAtIndex: | (NSUInteger) | index |
Removes the value at the given index.
- Parameters
-
index The index of the value to remove.
◆ removeValueAtIndex: [2/2]
| - (void) removeValueAtIndex: | (NSUInteger) | index |
Removes the value at the given index.
- Parameters
-
index The index of the value to remove.
◆ replaceValueAtIndex:withRawValue: [1/2]
| - (void) replaceValueAtIndex: | (NSUInteger) | index | |
| withRawValue: | (int32_t) | value | |
Replaces the raw enum value at the given index with the given value.
- Note
- This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
- Parameters
-
index The index for which to replace the value. value The raw enum value to replace with.
◆ replaceValueAtIndex:withRawValue: [2/2]
| - (void) replaceValueAtIndex: | (NSUInteger) | index | |
| withRawValue: | (int32_t) | value | |
Replaces the raw enum value at the given index with the given value.
- Note
- This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
- Parameters
-
index The index for which to replace the value. value The raw enum value to replace with.
◆ replaceValueAtIndex:withValue: [1/2]
| - (void) replaceValueAtIndex: | (NSUInteger) | index | |
| withValue: | (int32_t) | value | |
Replaces the value at the given index with the given value.
- Parameters
-
index The index for which to replace the value. value The value to replace with.
◆ replaceValueAtIndex:withValue: [2/2]
| - (void) replaceValueAtIndex: | (NSUInteger) | index | |
| withValue: | (int32_t) | value | |
Replaces the value at the given index with the given value.
- Parameters
-
index The index for which to replace the value. value The value to replace with.
◆ valueAtIndex: [1/2]
| - (int32_t) valueAtIndex: | (NSUInteger) | index |
Gets the value at the given index.
- Parameters
-
index The index of the value to get.
- Returns
- The value at the given index.
◆ valueAtIndex: [2/2]
| - (int32_t) valueAtIndex: | (NSUInteger) | index |
Gets the value at the given index.
- Parameters
-
index The index of the value to get.
- Returns
- The value at the given index.
Member Data Documentation
◆ _autocreator
|
protected |
Definition at line 118 of file bloaty/third_party/protobuf/objectivec/GPBArray_PackagePrivate.h.
Property Documentation
◆ count
|
readnonatomicassign |
The number of elements contained in the array.
Definition at line 1255 of file bloaty/third_party/protobuf/objectivec/GPBArray.h.
◆ validationFunc
|
readnonatomicassign |
The validation function to check if the enums are valid.
Definition at line 1257 of file bloaty/third_party/protobuf/objectivec/GPBArray.h.
The documentation for this class was generated from the following file: