Instance Methods | Protected Attributes | Properties | List of all members
GPBUInt64EnumDictionary Class Reference

#import <GPBDictionary.h>

Inheritance diagram for GPBUInt64EnumDictionary:
Inheritance graph
[legend]

Instance Methods

(void) - addRawEntriesFromDictionary:
 
(void) - addRawEntriesFromDictionary:
 
(void) - enumerateKeysAndEnumsUsingBlock:
 
(void) - enumerateKeysAndEnumsUsingBlock:
 
(void) - enumerateKeysAndRawValuesUsingBlock:
 
(void) - enumerateKeysAndRawValuesUsingBlock:
 
(BOOL- getEnum:forKey:
 
(BOOL- getEnum:forKey:
 
(BOOL- getRawValue:forKey:
 
(BOOL- getRawValue:forKey:
 
(instancetype) - initWithDictionary:
 
(instancetype) - initWithDictionary:
 
(instancetype) - initWithValidationFunction:
 
(instancetype) - initWithValidationFunction:
 
(instancetype) - initWithValidationFunction:capacity:
 
(instancetype) - initWithValidationFunction:capacity:
 
(instancetype) - initWithValidationFunction:rawValues:forKeys:count:
 
(instancetype) - initWithValidationFunction:rawValues:forKeys:count:
 
(void) - removeAll
 
(void) - removeAll
 
(void) - removeEnumForKey:
 
(void) - removeEnumForKey:
 
(NSData *) - serializedDataForUnknownValue:forKey:keyDataType: [implementation]
 
(NSData *) - serializedDataForUnknownValue:forKey:keyDataType: [implementation]
 
(void) - setEnum:forKey:
 
(void) - setEnum:forKey:
 
(void) - setRawValue:forKey:
 
(void) - setRawValue:forKey:
 
- Instance Methods inherited from <GPBDictionaryInternalsProtocol>
(size_t) - computeSerializedSizeAsField:
 
(size_t) - computeSerializedSizeAsField:
 
(void) - enumerateForTextFormat:
 
(void) - enumerateForTextFormat:
 
(void) - setGPBGenericValue:forGPBGenericValueKey:
 
(void) - setGPBGenericValue:forGPBGenericValueKey:
 
(void) - writeToCodedOutputStream:asField:
 
(void) - writeToCodedOutputStream:asField:
 

Protected Attributes

package GPB_UNSAFE_UNRETAINED GPBMessage_autocreator
 

Properties

NSUInteger count
 
GPBEnumValidationFunc validationFunc
 

Detailed Description

Class used for map fields of <uint64_t, int32_t> values. This performs better than boxing into NSNumbers in NSDictionaries.

Note
This class is not meant to be subclassed.

Definition at line 2564 of file bloaty/third_party/protobuf/objectivec/GPBDictionary.h.

Method Documentation

◆ addRawEntriesFromDictionary: [1/2]

- (void) addRawEntriesFromDictionary: (GPBUInt64EnumDictionary *)  otherDictionary

Adds the keys and raw enum values from another dictionary.

Note
This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
Parameters
otherDictionaryDictionary containing entries to be added to this dictionary.

◆ addRawEntriesFromDictionary: [2/2]

- (void) addRawEntriesFromDictionary: (GPBUInt64EnumDictionary *)  otherDictionary

Adds the keys and raw enum values from another dictionary.

Note
This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
Parameters
otherDictionaryDictionary containing entries to be added to this dictionary.

◆ enumerateKeysAndEnumsUsingBlock: [1/2]

- (void) enumerateKeysAndEnumsUsingBlock: (void(NS_NOESCAPE ^ block)(uint64_t key, int32_t value, BOOL *stop)) 

Enumerates the keys and values on this dictionary with the given block.

Parameters
blockThe block to enumerate with. key: The key for the current entry. value: The value for the current entry stop: A pointer to a boolean that when set stops the enumeration.

◆ enumerateKeysAndEnumsUsingBlock: [2/2]

- (void) enumerateKeysAndEnumsUsingBlock: (void(NS_NOESCAPE ^ block)(uint64_t key, int32_t value, BOOL *stop)) 

Enumerates the keys and values on this dictionary with the given block.

Parameters
blockThe block to enumerate with. key: The key for the current entry. value: The value for the current entry stop: A pointer to a boolean that when set stops the enumeration.

◆ enumerateKeysAndRawValuesUsingBlock: [1/2]

- (void) enumerateKeysAndRawValuesUsingBlock: (void(NS_NOESCAPE ^ block)(uint64_t key, int32_t rawValue, BOOL *stop)) 

Enumerates the keys and values on this dictionary with the given block.

Note
This method bypass the validationFunc to enable the access of values that were not known at the time the binary was compiled.
Parameters
blockThe block to enumerate with. key: The key for the current entry. rawValue: The value for the current entry stop: A pointer to a boolean that when set stops the enumeration.

◆ enumerateKeysAndRawValuesUsingBlock: [2/2]

- (void) enumerateKeysAndRawValuesUsingBlock: (void(NS_NOESCAPE ^ block)(uint64_t key, int32_t rawValue, BOOL *stop)) 

Enumerates the keys and values on this dictionary with the given block.

Note
This method bypass the validationFunc to enable the access of values that were not known at the time the binary was compiled.
Parameters
blockThe block to enumerate with. key: The key for the current entry. rawValue: The value for the current entry stop: A pointer to a boolean that when set stops the enumeration.

◆ getEnum:forKey: [1/2]

- (BOOL) getEnum: (nullable int32_t *)  value
forKey: (uint64_t key 

Gets the value for the given key.

Parameters
valuePointer into which the value will be set, if found.
keyKey under which the value is stored, if present.
Returns
YES if the key was found and the value was copied, NO otherwise.

◆ getEnum:forKey: [2/2]

- (BOOL) getEnum: (nullable int32_t *)  value
forKey: (uint64_t key 

Gets the value for the given key.

Parameters
valuePointer into which the value will be set, if found.
keyKey under which the value is stored, if present.
Returns
YES if the key was found and the value was copied, NO otherwise.

◆ getRawValue:forKey: [1/2]

- (BOOL) getRawValue: (nullable int32_t *)  rawValue
forKey: (uint64_t key 

Gets the raw enum value for the given key.

Note
This method bypass the validationFunc to enable the access of values that were not known at the time the binary was compiled.
Parameters
rawValuePointer into which the value will be set, if found.
keyKey under which the value is stored, if present.
Returns
YES if the key was found and the value was copied, NO otherwise.

◆ getRawValue:forKey: [2/2]

- (BOOL) getRawValue: (nullable int32_t *)  rawValue
forKey: (uint64_t key 

Gets the raw enum value for the given key.

Note
This method bypass the validationFunc to enable the access of values that were not known at the time the binary was compiled.
Parameters
rawValuePointer into which the value will be set, if found.
keyKey under which the value is stored, if present.
Returns
YES if the key was found and the value was copied, NO otherwise.

◆ initWithDictionary: [1/2]

- (instancetype) initWithDictionary: (GPBUInt64EnumDictionary *)  dictionary

Initializes a dictionary with the entries from the given. dictionary.

Parameters
dictionaryDictionary containing the entries to add to the dictionary.
Returns
A newly initialized dictionary with the entries from the given dictionary in it.

◆ initWithDictionary: [2/2]

- (instancetype) initWithDictionary: (GPBUInt64EnumDictionary *)  dictionary

Initializes a dictionary with the entries from the given. dictionary.

Parameters
dictionaryDictionary containing the entries to add to the dictionary.
Returns
A newly initialized dictionary with the entries from the given dictionary in it.

◆ initWithValidationFunction: [1/2]

- (instancetype) initWithValidationFunction: (nullable GPBEnumValidationFunc func

Initializes a dictionary with the given validation function.

Parameters
funcThe enum validation function for the dictionary.
Returns
A newly initialized dictionary.

◆ initWithValidationFunction: [2/2]

- (instancetype) initWithValidationFunction: (nullable GPBEnumValidationFunc func

Initializes a dictionary with the given validation function.

Parameters
funcThe enum validation function for the dictionary.
Returns
A newly initialized dictionary.

◆ initWithValidationFunction:capacity: [1/2]

- (instancetype) initWithValidationFunction: (nullable GPBEnumValidationFunc func
capacity: (NSUInteger)  numItems 

Initializes a dictionary with the given capacity.

Parameters
funcThe enum validation function for the dictionary.
numItemsCapacity needed for the dictionary.
Returns
A newly initialized dictionary with the given capacity.

◆ initWithValidationFunction:capacity: [2/2]

- (instancetype) initWithValidationFunction: (nullable GPBEnumValidationFunc func
capacity: (NSUInteger)  numItems 

Initializes a dictionary with the given capacity.

Parameters
funcThe enum validation function for the dictionary.
numItemsCapacity needed for the dictionary.
Returns
A newly initialized dictionary with the given capacity.

◆ initWithValidationFunction:rawValues:forKeys:count: [1/2]

- (instancetype) initWithValidationFunction: (nullable GPBEnumValidationFunc func
rawValues: (const int32_t values[__nullable]
forKeys: (const uint64_t keys[__nullable]
count: (NSUInteger)  NS_DESIGNATED_INITIALIZER 

Initializes a dictionary with the entries given.

Parameters
funcThe enum validation function for the dictionary.
valuesThe raw enum values values to be placed in the dictionary.
keysThe keys under which to store the values.
countThe number of entries to store in the dictionary.
Returns
A newly initialized dictionary with the keys and values in it.

◆ initWithValidationFunction:rawValues:forKeys:count: [2/2]

- (instancetype) initWithValidationFunction: (nullable GPBEnumValidationFunc func
rawValues: (const int32_t values[__nullable]
forKeys: (const uint64_t keys[__nullable]
count: (NSUInteger)  NS_DESIGNATED_INITIALIZER 

Initializes a dictionary with the entries given.

Parameters
funcThe enum validation function for the dictionary.
valuesThe raw enum values values to be placed in the dictionary.
keysThe keys under which to store the values.
countThe number of entries to store in the dictionary.
Returns
A newly initialized dictionary with the keys and values in it.

◆ removeAll [1/2]

- (void) removeAll

Removes all entries in this dictionary.

◆ removeAll [2/2]

- (void) removeAll

Removes all entries in this dictionary.

◆ removeEnumForKey: [1/2]

- (void) removeEnumForKey: (uint64_t aKey

Removes the entry for the given key.

Parameters
aKeyKey to be removed from this dictionary.

◆ removeEnumForKey: [2/2]

- (void) removeEnumForKey: (uint64_t aKey

Removes the entry for the given key.

Parameters
aKeyKey to be removed from this dictionary.

◆ serializedDataForUnknownValue:forKey:keyDataType: [1/2]

- (NSData *) serializedDataForUnknownValue: (int32_t value
forKey: (GPBGenericValue *)  key
keyDataType: (GPBDataType)  keyDataType 
implementation

◆ serializedDataForUnknownValue:forKey:keyDataType: [2/2]

- (NSData *) serializedDataForUnknownValue: (int32_t value
forKey: (GPBGenericValue *)  key
keyDataType: (GPBDataType)  keyDataType 
implementation

◆ setEnum:forKey: [1/2]

- (void) setEnum: (int32_t value
forKey: (uint64_t key 

Sets the value for the given key.

Parameters
valueThe value to set.
keyThe key under which to store the value.

◆ setEnum:forKey: [2/2]

- (void) setEnum: (int32_t value
forKey: (uint64_t key 

Sets the value for the given key.

Parameters
valueThe value to set.
keyThe key under which to store the value.

◆ setRawValue:forKey: [1/2]

- (void) setRawValue: (int32_t rawValue
forKey: (uint64_t key 

Sets the raw enum value for the given key.

Note
This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
Parameters
rawValueThe raw enum value to set.
keyThe key under which to store the raw enum value.

◆ setRawValue:forKey: [2/2]

- (void) setRawValue: (int32_t rawValue
forKey: (uint64_t key 

Sets the raw enum value for the given key.

Note
This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.
Parameters
rawValueThe raw enum value to set.
keyThe key under which to store the raw enum value.

Member Data Documentation

◆ _autocreator

- (package GPB_UNSAFE_UNRETAINED GPBMessage *) _autocreator
protected

Property Documentation

◆ count

- (NSUInteger) count
readnonatomicassign

Number of entries stored in this dictionary.

Definition at line 2567 of file bloaty/third_party/protobuf/objectivec/GPBDictionary.h.

◆ validationFunc

- (GPBEnumValidationFunc) validationFunc
readnonatomicassign

The validation function to check if the enums are valid.

Definition at line 2569 of file bloaty/third_party/protobuf/objectivec/GPBDictionary.h.


The documentation for this class was generated from the following file:


grpc
Author(s):
autogenerated on Fri May 16 2025 03:01:45