1*6777b538SAndroid Build Coastguard Worker // Protocol Buffers - Google's data interchange format 2*6777b538SAndroid Build Coastguard Worker // Copyright 2008 Google Inc. All rights reserved. 3*6777b538SAndroid Build Coastguard Worker // https://developers.google.com/protocol-buffers/ 4*6777b538SAndroid Build Coastguard Worker // 5*6777b538SAndroid Build Coastguard Worker // Redistribution and use in source and binary forms, with or without 6*6777b538SAndroid Build Coastguard Worker // modification, are permitted provided that the following conditions are 7*6777b538SAndroid Build Coastguard Worker // met: 8*6777b538SAndroid Build Coastguard Worker // 9*6777b538SAndroid Build Coastguard Worker // * Redistributions of source code must retain the above copyright 10*6777b538SAndroid Build Coastguard Worker // notice, this list of conditions and the following disclaimer. 11*6777b538SAndroid Build Coastguard Worker // * Redistributions in binary form must reproduce the above 12*6777b538SAndroid Build Coastguard Worker // copyright notice, this list of conditions and the following disclaimer 13*6777b538SAndroid Build Coastguard Worker // in the documentation and/or other materials provided with the 14*6777b538SAndroid Build Coastguard Worker // distribution. 15*6777b538SAndroid Build Coastguard Worker // * Neither the name of Google Inc. nor the names of its 16*6777b538SAndroid Build Coastguard Worker // contributors may be used to endorse or promote products derived from 17*6777b538SAndroid Build Coastguard Worker // this software without specific prior written permission. 18*6777b538SAndroid Build Coastguard Worker // 19*6777b538SAndroid Build Coastguard Worker // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20*6777b538SAndroid Build Coastguard Worker // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21*6777b538SAndroid Build Coastguard Worker // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22*6777b538SAndroid Build Coastguard Worker // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23*6777b538SAndroid Build Coastguard Worker // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24*6777b538SAndroid Build Coastguard Worker // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25*6777b538SAndroid Build Coastguard Worker // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26*6777b538SAndroid Build Coastguard Worker // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27*6777b538SAndroid Build Coastguard Worker // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28*6777b538SAndroid Build Coastguard Worker // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29*6777b538SAndroid Build Coastguard Worker // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30*6777b538SAndroid Build Coastguard Worker 31*6777b538SAndroid Build Coastguard Worker #import <Foundation/Foundation.h> 32*6777b538SAndroid Build Coastguard Worker 33*6777b538SAndroid Build Coastguard Worker #import "GPBBootstrap.h" 34*6777b538SAndroid Build Coastguard Worker 35*6777b538SAndroid Build Coastguard Worker @class GPBDescriptor; 36*6777b538SAndroid Build Coastguard Worker @class GPBCodedInputStream; 37*6777b538SAndroid Build Coastguard Worker @class GPBCodedOutputStream; 38*6777b538SAndroid Build Coastguard Worker @class GPBExtensionDescriptor; 39*6777b538SAndroid Build Coastguard Worker @class GPBExtensionRegistry; 40*6777b538SAndroid Build Coastguard Worker @class GPBFieldDescriptor; 41*6777b538SAndroid Build Coastguard Worker @class GPBUnknownFieldSet; 42*6777b538SAndroid Build Coastguard Worker 43*6777b538SAndroid Build Coastguard Worker NS_ASSUME_NONNULL_BEGIN 44*6777b538SAndroid Build Coastguard Worker 45*6777b538SAndroid Build Coastguard Worker CF_EXTERN_C_BEGIN 46*6777b538SAndroid Build Coastguard Worker 47*6777b538SAndroid Build Coastguard Worker /** NSError domain used for errors. */ 48*6777b538SAndroid Build Coastguard Worker extern NSString *const GPBMessageErrorDomain; 49*6777b538SAndroid Build Coastguard Worker 50*6777b538SAndroid Build Coastguard Worker /** Error codes for NSErrors originated in GPBMessage. */ 51*6777b538SAndroid Build Coastguard Worker typedef NS_ENUM(NSInteger, GPBMessageErrorCode) { 52*6777b538SAndroid Build Coastguard Worker /** Uncategorized error. */ 53*6777b538SAndroid Build Coastguard Worker GPBMessageErrorCodeOther = -100, 54*6777b538SAndroid Build Coastguard Worker /** Message couldn't be serialized because it is missing required fields. */ 55*6777b538SAndroid Build Coastguard Worker GPBMessageErrorCodeMissingRequiredField = -101, 56*6777b538SAndroid Build Coastguard Worker }; 57*6777b538SAndroid Build Coastguard Worker 58*6777b538SAndroid Build Coastguard Worker /** 59*6777b538SAndroid Build Coastguard Worker * Key under which the GPBMessage error's reason is stored inside the userInfo 60*6777b538SAndroid Build Coastguard Worker * dictionary. 61*6777b538SAndroid Build Coastguard Worker **/ 62*6777b538SAndroid Build Coastguard Worker extern NSString *const GPBErrorReasonKey; 63*6777b538SAndroid Build Coastguard Worker 64*6777b538SAndroid Build Coastguard Worker CF_EXTERN_C_END 65*6777b538SAndroid Build Coastguard Worker 66*6777b538SAndroid Build Coastguard Worker /** 67*6777b538SAndroid Build Coastguard Worker * Base class that each generated message subclasses from. 68*6777b538SAndroid Build Coastguard Worker * 69*6777b538SAndroid Build Coastguard Worker * @note @c NSCopying support is a "deep copy", in that all sub objects are 70*6777b538SAndroid Build Coastguard Worker * copied. Just like you wouldn't want a UIView/NSView trying to 71*6777b538SAndroid Build Coastguard Worker * exist in two places, you don't want a sub message to be a property 72*6777b538SAndroid Build Coastguard Worker * property of two other messages. 73*6777b538SAndroid Build Coastguard Worker * 74*6777b538SAndroid Build Coastguard Worker * @note While the class support NSSecureCoding, if the message has any 75*6777b538SAndroid Build Coastguard Worker * extensions, they will end up reloaded in @c unknownFields as there is 76*6777b538SAndroid Build Coastguard Worker * no way for the @c NSCoding plumbing to pass through a 77*6777b538SAndroid Build Coastguard Worker * @c GPBExtensionRegistry. To support extensions, instead of passing the 78*6777b538SAndroid Build Coastguard Worker * calls off to the Message, simple store the result of @c data, and then 79*6777b538SAndroid Build Coastguard Worker * when loading, fetch the data and use 80*6777b538SAndroid Build Coastguard Worker * @c +parseFromData:extensionRegistry:error: to provide an extension 81*6777b538SAndroid Build Coastguard Worker * registry. 82*6777b538SAndroid Build Coastguard Worker **/ 83*6777b538SAndroid Build Coastguard Worker @interface GPBMessage : NSObject<NSSecureCoding, NSCopying> 84*6777b538SAndroid Build Coastguard Worker 85*6777b538SAndroid Build Coastguard Worker // If you add an instance method/property to this class that may conflict with 86*6777b538SAndroid Build Coastguard Worker // fields declared in protos, you need to update objective_helpers.cc. The main 87*6777b538SAndroid Build Coastguard Worker // cases are methods that take no arguments, or setFoo:/hasFoo: type methods. 88*6777b538SAndroid Build Coastguard Worker 89*6777b538SAndroid Build Coastguard Worker /** 90*6777b538SAndroid Build Coastguard Worker * The set of unknown fields for this message. 91*6777b538SAndroid Build Coastguard Worker * 92*6777b538SAndroid Build Coastguard Worker * Only messages from proto files declared with "proto2" syntax support unknown 93*6777b538SAndroid Build Coastguard Worker * fields. For "proto3" syntax, any unknown fields found while parsing are 94*6777b538SAndroid Build Coastguard Worker * dropped. 95*6777b538SAndroid Build Coastguard Worker **/ 96*6777b538SAndroid Build Coastguard Worker @property(nonatomic, copy, nullable) GPBUnknownFieldSet *unknownFields; 97*6777b538SAndroid Build Coastguard Worker 98*6777b538SAndroid Build Coastguard Worker /** 99*6777b538SAndroid Build Coastguard Worker * Whether the message, along with all submessages, have the required fields 100*6777b538SAndroid Build Coastguard Worker * set. This is only applicable for files declared with "proto2" syntax, as 101*6777b538SAndroid Build Coastguard Worker * there are no required fields for "proto3" syntax. 102*6777b538SAndroid Build Coastguard Worker **/ 103*6777b538SAndroid Build Coastguard Worker @property(nonatomic, readonly, getter=isInitialized) BOOL initialized; 104*6777b538SAndroid Build Coastguard Worker 105*6777b538SAndroid Build Coastguard Worker /** 106*6777b538SAndroid Build Coastguard Worker * @return An autoreleased message with the default values set. 107*6777b538SAndroid Build Coastguard Worker **/ 108*6777b538SAndroid Build Coastguard Worker + (instancetype)message; 109*6777b538SAndroid Build Coastguard Worker 110*6777b538SAndroid Build Coastguard Worker /** 111*6777b538SAndroid Build Coastguard Worker * Creates a new instance by parsing the provided data. This method should be 112*6777b538SAndroid Build Coastguard Worker * sent to the generated message class that the data should be interpreted as. 113*6777b538SAndroid Build Coastguard Worker * If there is an error the method returns nil and the error is returned in 114*6777b538SAndroid Build Coastguard Worker * errorPtr (when provided). 115*6777b538SAndroid Build Coastguard Worker * 116*6777b538SAndroid Build Coastguard Worker * @note In DEBUG builds, the parsed message is checked to be sure all required 117*6777b538SAndroid Build Coastguard Worker * fields were provided, and the parse will fail if some are missing. 118*6777b538SAndroid Build Coastguard Worker * 119*6777b538SAndroid Build Coastguard Worker * @note The errors returned are likely coming from the domain and codes listed 120*6777b538SAndroid Build Coastguard Worker * at the top of this file and GPBCodedInputStream.h. 121*6777b538SAndroid Build Coastguard Worker * 122*6777b538SAndroid Build Coastguard Worker * @param data The data to parse. 123*6777b538SAndroid Build Coastguard Worker * @param errorPtr An optional error pointer to fill in with a failure reason if 124*6777b538SAndroid Build Coastguard Worker * the data can not be parsed. 125*6777b538SAndroid Build Coastguard Worker * 126*6777b538SAndroid Build Coastguard Worker * @return A new instance of the generated class. 127*6777b538SAndroid Build Coastguard Worker **/ 128*6777b538SAndroid Build Coastguard Worker + (nullable instancetype)parseFromData:(NSData *)data error:(NSError **)errorPtr; 129*6777b538SAndroid Build Coastguard Worker 130*6777b538SAndroid Build Coastguard Worker /** 131*6777b538SAndroid Build Coastguard Worker * Creates a new instance by parsing the data. This method should be sent to 132*6777b538SAndroid Build Coastguard Worker * the generated message class that the data should be interpreted as. If 133*6777b538SAndroid Build Coastguard Worker * there is an error the method returns nil and the error is returned in 134*6777b538SAndroid Build Coastguard Worker * errorPtr (when provided). 135*6777b538SAndroid Build Coastguard Worker * 136*6777b538SAndroid Build Coastguard Worker * @note In DEBUG builds, the parsed message is checked to be sure all required 137*6777b538SAndroid Build Coastguard Worker * fields were provided, and the parse will fail if some are missing. 138*6777b538SAndroid Build Coastguard Worker * 139*6777b538SAndroid Build Coastguard Worker * @note The errors returned are likely coming from the domain and codes listed 140*6777b538SAndroid Build Coastguard Worker * at the top of this file and GPBCodedInputStream.h. 141*6777b538SAndroid Build Coastguard Worker * 142*6777b538SAndroid Build Coastguard Worker * @param data The data to parse. 143*6777b538SAndroid Build Coastguard Worker * @param extensionRegistry The extension registry to use to look up extensions. 144*6777b538SAndroid Build Coastguard Worker * @param errorPtr An optional error pointer to fill in with a failure 145*6777b538SAndroid Build Coastguard Worker * reason if the data can not be parsed. 146*6777b538SAndroid Build Coastguard Worker * 147*6777b538SAndroid Build Coastguard Worker * @return A new instance of the generated class. 148*6777b538SAndroid Build Coastguard Worker **/ 149*6777b538SAndroid Build Coastguard Worker + (nullable instancetype)parseFromData:(NSData *)data 150*6777b538SAndroid Build Coastguard Worker extensionRegistry:(nullable GPBExtensionRegistry *)extensionRegistry 151*6777b538SAndroid Build Coastguard Worker error:(NSError **)errorPtr; 152*6777b538SAndroid Build Coastguard Worker 153*6777b538SAndroid Build Coastguard Worker /** 154*6777b538SAndroid Build Coastguard Worker * Creates a new instance by parsing the data from the given input stream. This 155*6777b538SAndroid Build Coastguard Worker * method should be sent to the generated message class that the data should 156*6777b538SAndroid Build Coastguard Worker * be interpreted as. If there is an error the method returns nil and the error 157*6777b538SAndroid Build Coastguard Worker * is returned in errorPtr (when provided). 158*6777b538SAndroid Build Coastguard Worker * 159*6777b538SAndroid Build Coastguard Worker * @note In DEBUG builds, the parsed message is checked to be sure all required 160*6777b538SAndroid Build Coastguard Worker * fields were provided, and the parse will fail if some are missing. 161*6777b538SAndroid Build Coastguard Worker * 162*6777b538SAndroid Build Coastguard Worker * @note The errors returned are likely coming from the domain and codes listed 163*6777b538SAndroid Build Coastguard Worker * at the top of this file and GPBCodedInputStream.h. 164*6777b538SAndroid Build Coastguard Worker * 165*6777b538SAndroid Build Coastguard Worker * @param input The stream to read data from. 166*6777b538SAndroid Build Coastguard Worker * @param extensionRegistry The extension registry to use to look up extensions. 167*6777b538SAndroid Build Coastguard Worker * @param errorPtr An optional error pointer to fill in with a failure 168*6777b538SAndroid Build Coastguard Worker * reason if the data can not be parsed. 169*6777b538SAndroid Build Coastguard Worker * 170*6777b538SAndroid Build Coastguard Worker * @return A new instance of the generated class. 171*6777b538SAndroid Build Coastguard Worker **/ 172*6777b538SAndroid Build Coastguard Worker + (nullable instancetype)parseFromCodedInputStream:(GPBCodedInputStream *)input 173*6777b538SAndroid Build Coastguard Worker extensionRegistry: 174*6777b538SAndroid Build Coastguard Worker (nullable GPBExtensionRegistry *)extensionRegistry 175*6777b538SAndroid Build Coastguard Worker error:(NSError **)errorPtr; 176*6777b538SAndroid Build Coastguard Worker 177*6777b538SAndroid Build Coastguard Worker /** 178*6777b538SAndroid Build Coastguard Worker * Creates a new instance by parsing the data from the given input stream. This 179*6777b538SAndroid Build Coastguard Worker * method should be sent to the generated message class that the data should 180*6777b538SAndroid Build Coastguard Worker * be interpreted as. If there is an error the method returns nil and the error 181*6777b538SAndroid Build Coastguard Worker * is returned in errorPtr (when provided). 182*6777b538SAndroid Build Coastguard Worker * 183*6777b538SAndroid Build Coastguard Worker * @note Unlike the parseFrom... methods, this never checks to see if all of 184*6777b538SAndroid Build Coastguard Worker * the required fields are set. So this method can be used to reload 185*6777b538SAndroid Build Coastguard Worker * messages that may not be complete. 186*6777b538SAndroid Build Coastguard Worker * 187*6777b538SAndroid Build Coastguard Worker * @note The errors returned are likely coming from the domain and codes listed 188*6777b538SAndroid Build Coastguard Worker * at the top of this file and GPBCodedInputStream.h. 189*6777b538SAndroid Build Coastguard Worker * 190*6777b538SAndroid Build Coastguard Worker * @param input The stream to read data from. 191*6777b538SAndroid Build Coastguard Worker * @param extensionRegistry The extension registry to use to look up extensions. 192*6777b538SAndroid Build Coastguard Worker * @param errorPtr An optional error pointer to fill in with a failure 193*6777b538SAndroid Build Coastguard Worker * reason if the data can not be parsed. 194*6777b538SAndroid Build Coastguard Worker * 195*6777b538SAndroid Build Coastguard Worker * @return A new instance of the generated class. 196*6777b538SAndroid Build Coastguard Worker **/ 197*6777b538SAndroid Build Coastguard Worker + (nullable instancetype)parseDelimitedFromCodedInputStream:(GPBCodedInputStream *)input 198*6777b538SAndroid Build Coastguard Worker extensionRegistry: 199*6777b538SAndroid Build Coastguard Worker (nullable GPBExtensionRegistry *)extensionRegistry 200*6777b538SAndroid Build Coastguard Worker error:(NSError **)errorPtr; 201*6777b538SAndroid Build Coastguard Worker 202*6777b538SAndroid Build Coastguard Worker /** 203*6777b538SAndroid Build Coastguard Worker * Initializes an instance by parsing the data. This method should be sent to 204*6777b538SAndroid Build Coastguard Worker * the generated message class that the data should be interpreted as. If 205*6777b538SAndroid Build Coastguard Worker * there is an error the method returns nil and the error is returned in 206*6777b538SAndroid Build Coastguard Worker * errorPtr (when provided). 207*6777b538SAndroid Build Coastguard Worker * 208*6777b538SAndroid Build Coastguard Worker * @note In DEBUG builds, the parsed message is checked to be sure all required 209*6777b538SAndroid Build Coastguard Worker * fields were provided, and the parse will fail if some are missing. 210*6777b538SAndroid Build Coastguard Worker * 211*6777b538SAndroid Build Coastguard Worker * @note The errors returned are likely coming from the domain and codes listed 212*6777b538SAndroid Build Coastguard Worker * at the top of this file and GPBCodedInputStream.h. 213*6777b538SAndroid Build Coastguard Worker * 214*6777b538SAndroid Build Coastguard Worker * @param data The data to parse. 215*6777b538SAndroid Build Coastguard Worker * @param errorPtr An optional error pointer to fill in with a failure reason if 216*6777b538SAndroid Build Coastguard Worker * the data can not be parsed. 217*6777b538SAndroid Build Coastguard Worker * 218*6777b538SAndroid Build Coastguard Worker * @return An initialized instance of the generated class. 219*6777b538SAndroid Build Coastguard Worker **/ 220*6777b538SAndroid Build Coastguard Worker - (nullable instancetype)initWithData:(NSData *)data error:(NSError **)errorPtr; 221*6777b538SAndroid Build Coastguard Worker 222*6777b538SAndroid Build Coastguard Worker /** 223*6777b538SAndroid Build Coastguard Worker * Initializes an instance by parsing the data. This method should be sent to 224*6777b538SAndroid Build Coastguard Worker * the generated message class that the data should be interpreted as. If 225*6777b538SAndroid Build Coastguard Worker * there is an error the method returns nil and the error is returned in 226*6777b538SAndroid Build Coastguard Worker * errorPtr (when provided). 227*6777b538SAndroid Build Coastguard Worker * 228*6777b538SAndroid Build Coastguard Worker * @note In DEBUG builds, the parsed message is checked to be sure all required 229*6777b538SAndroid Build Coastguard Worker * fields were provided, and the parse will fail if some are missing. 230*6777b538SAndroid Build Coastguard Worker * 231*6777b538SAndroid Build Coastguard Worker * @note The errors returned are likely coming from the domain and codes listed 232*6777b538SAndroid Build Coastguard Worker * at the top of this file and GPBCodedInputStream.h. 233*6777b538SAndroid Build Coastguard Worker * 234*6777b538SAndroid Build Coastguard Worker * @param data The data to parse. 235*6777b538SAndroid Build Coastguard Worker * @param extensionRegistry The extension registry to use to look up extensions. 236*6777b538SAndroid Build Coastguard Worker * @param errorPtr An optional error pointer to fill in with a failure 237*6777b538SAndroid Build Coastguard Worker * reason if the data can not be parsed. 238*6777b538SAndroid Build Coastguard Worker * 239*6777b538SAndroid Build Coastguard Worker * @return An initialized instance of the generated class. 240*6777b538SAndroid Build Coastguard Worker **/ 241*6777b538SAndroid Build Coastguard Worker - (nullable instancetype)initWithData:(NSData *)data 242*6777b538SAndroid Build Coastguard Worker extensionRegistry:(nullable GPBExtensionRegistry *)extensionRegistry 243*6777b538SAndroid Build Coastguard Worker error:(NSError **)errorPtr; 244*6777b538SAndroid Build Coastguard Worker 245*6777b538SAndroid Build Coastguard Worker /** 246*6777b538SAndroid Build Coastguard Worker * Initializes an instance by parsing the data from the given input stream. This 247*6777b538SAndroid Build Coastguard Worker * method should be sent to the generated message class that the data should 248*6777b538SAndroid Build Coastguard Worker * be interpreted as. If there is an error the method returns nil and the error 249*6777b538SAndroid Build Coastguard Worker * is returned in errorPtr (when provided). 250*6777b538SAndroid Build Coastguard Worker * 251*6777b538SAndroid Build Coastguard Worker * @note Unlike the parseFrom... methods, this never checks to see if all of 252*6777b538SAndroid Build Coastguard Worker * the required fields are set. So this method can be used to reload 253*6777b538SAndroid Build Coastguard Worker * messages that may not be complete. 254*6777b538SAndroid Build Coastguard Worker * 255*6777b538SAndroid Build Coastguard Worker * @note The errors returned are likely coming from the domain and codes listed 256*6777b538SAndroid Build Coastguard Worker * at the top of this file and GPBCodedInputStream.h. 257*6777b538SAndroid Build Coastguard Worker * 258*6777b538SAndroid Build Coastguard Worker * @param input The stream to read data from. 259*6777b538SAndroid Build Coastguard Worker * @param extensionRegistry The extension registry to use to look up extensions. 260*6777b538SAndroid Build Coastguard Worker * @param errorPtr An optional error pointer to fill in with a failure 261*6777b538SAndroid Build Coastguard Worker * reason if the data can not be parsed. 262*6777b538SAndroid Build Coastguard Worker * 263*6777b538SAndroid Build Coastguard Worker * @return An initialized instance of the generated class. 264*6777b538SAndroid Build Coastguard Worker **/ 265*6777b538SAndroid Build Coastguard Worker - (nullable instancetype)initWithCodedInputStream:(GPBCodedInputStream *)input 266*6777b538SAndroid Build Coastguard Worker extensionRegistry: 267*6777b538SAndroid Build Coastguard Worker (nullable GPBExtensionRegistry *)extensionRegistry 268*6777b538SAndroid Build Coastguard Worker error:(NSError **)errorPtr; 269*6777b538SAndroid Build Coastguard Worker 270*6777b538SAndroid Build Coastguard Worker /** 271*6777b538SAndroid Build Coastguard Worker * Parses the given data as this message's class, and merges those values into 272*6777b538SAndroid Build Coastguard Worker * this message. 273*6777b538SAndroid Build Coastguard Worker * 274*6777b538SAndroid Build Coastguard Worker * @param data The binary representation of the message to merge. 275*6777b538SAndroid Build Coastguard Worker * @param extensionRegistry The extension registry to use to look up extensions. 276*6777b538SAndroid Build Coastguard Worker * 277*6777b538SAndroid Build Coastguard Worker * @exception GPBCodedInputStreamException Exception thrown when parsing was 278*6777b538SAndroid Build Coastguard Worker * unsuccessful. 279*6777b538SAndroid Build Coastguard Worker **/ 280*6777b538SAndroid Build Coastguard Worker - (void)mergeFromData:(NSData *)data 281*6777b538SAndroid Build Coastguard Worker extensionRegistry:(nullable GPBExtensionRegistry *)extensionRegistry; 282*6777b538SAndroid Build Coastguard Worker 283*6777b538SAndroid Build Coastguard Worker /** 284*6777b538SAndroid Build Coastguard Worker * Merges the fields from another message (of the same type) into this 285*6777b538SAndroid Build Coastguard Worker * message. 286*6777b538SAndroid Build Coastguard Worker * 287*6777b538SAndroid Build Coastguard Worker * @param other Message to merge into this message. 288*6777b538SAndroid Build Coastguard Worker **/ 289*6777b538SAndroid Build Coastguard Worker - (void)mergeFrom:(GPBMessage *)other; 290*6777b538SAndroid Build Coastguard Worker 291*6777b538SAndroid Build Coastguard Worker /** 292*6777b538SAndroid Build Coastguard Worker * Writes out the message to the given coded output stream. 293*6777b538SAndroid Build Coastguard Worker * 294*6777b538SAndroid Build Coastguard Worker * @param output The coded output stream into which to write the message. 295*6777b538SAndroid Build Coastguard Worker * 296*6777b538SAndroid Build Coastguard Worker * @note This can raise the GPBCodedOutputStreamException_* exceptions. 297*6777b538SAndroid Build Coastguard Worker * 298*6777b538SAndroid Build Coastguard Worker **/ 299*6777b538SAndroid Build Coastguard Worker - (void)writeToCodedOutputStream:(GPBCodedOutputStream *)output; 300*6777b538SAndroid Build Coastguard Worker 301*6777b538SAndroid Build Coastguard Worker /** 302*6777b538SAndroid Build Coastguard Worker * Writes out the message to the given output stream. 303*6777b538SAndroid Build Coastguard Worker * 304*6777b538SAndroid Build Coastguard Worker * @param output The output stream into which to write the message. 305*6777b538SAndroid Build Coastguard Worker * 306*6777b538SAndroid Build Coastguard Worker * @note This can raise the GPBCodedOutputStreamException_* exceptions. 307*6777b538SAndroid Build Coastguard Worker **/ 308*6777b538SAndroid Build Coastguard Worker - (void)writeToOutputStream:(NSOutputStream *)output; 309*6777b538SAndroid Build Coastguard Worker 310*6777b538SAndroid Build Coastguard Worker /** 311*6777b538SAndroid Build Coastguard Worker * Writes out a varint for the message size followed by the message to 312*6777b538SAndroid Build Coastguard Worker * the given output stream. 313*6777b538SAndroid Build Coastguard Worker * 314*6777b538SAndroid Build Coastguard Worker * @param output The coded output stream into which to write the message. 315*6777b538SAndroid Build Coastguard Worker * 316*6777b538SAndroid Build Coastguard Worker * @note This can raise the GPBCodedOutputStreamException_* exceptions. 317*6777b538SAndroid Build Coastguard Worker **/ 318*6777b538SAndroid Build Coastguard Worker - (void)writeDelimitedToCodedOutputStream:(GPBCodedOutputStream *)output; 319*6777b538SAndroid Build Coastguard Worker 320*6777b538SAndroid Build Coastguard Worker /** 321*6777b538SAndroid Build Coastguard Worker * Writes out a varint for the message size followed by the message to 322*6777b538SAndroid Build Coastguard Worker * the given output stream. 323*6777b538SAndroid Build Coastguard Worker * 324*6777b538SAndroid Build Coastguard Worker * @param output The output stream into which to write the message. 325*6777b538SAndroid Build Coastguard Worker * 326*6777b538SAndroid Build Coastguard Worker * @note This can raise the GPBCodedOutputStreamException_* exceptions. 327*6777b538SAndroid Build Coastguard Worker **/ 328*6777b538SAndroid Build Coastguard Worker - (void)writeDelimitedToOutputStream:(NSOutputStream *)output; 329*6777b538SAndroid Build Coastguard Worker 330*6777b538SAndroid Build Coastguard Worker /** 331*6777b538SAndroid Build Coastguard Worker * Serializes the message to an NSData. 332*6777b538SAndroid Build Coastguard Worker * 333*6777b538SAndroid Build Coastguard Worker * If there is an error while generating the data, nil is returned. 334*6777b538SAndroid Build Coastguard Worker * 335*6777b538SAndroid Build Coastguard Worker * @note This value is not cached, so if you are using it repeatedly, cache 336*6777b538SAndroid Build Coastguard Worker * it yourself. 337*6777b538SAndroid Build Coastguard Worker * 338*6777b538SAndroid Build Coastguard Worker * @note In DEBUG ONLY, the message is also checked for all required field, 339*6777b538SAndroid Build Coastguard Worker * if one is missing, nil will be returned. 340*6777b538SAndroid Build Coastguard Worker * 341*6777b538SAndroid Build Coastguard Worker * @return The binary representation of the message. 342*6777b538SAndroid Build Coastguard Worker **/ 343*6777b538SAndroid Build Coastguard Worker - (nullable NSData *)data; 344*6777b538SAndroid Build Coastguard Worker 345*6777b538SAndroid Build Coastguard Worker /** 346*6777b538SAndroid Build Coastguard Worker * Serializes a varint with the message size followed by the message data, 347*6777b538SAndroid Build Coastguard Worker * returning that as an NSData. 348*6777b538SAndroid Build Coastguard Worker * 349*6777b538SAndroid Build Coastguard Worker * @note This value is not cached, so if you are using it repeatedly, it is 350*6777b538SAndroid Build Coastguard Worker * recommended to keep a local copy. 351*6777b538SAndroid Build Coastguard Worker * 352*6777b538SAndroid Build Coastguard Worker * @return The binary representation of the size along with the message. 353*6777b538SAndroid Build Coastguard Worker **/ 354*6777b538SAndroid Build Coastguard Worker - (NSData *)delimitedData; 355*6777b538SAndroid Build Coastguard Worker 356*6777b538SAndroid Build Coastguard Worker /** 357*6777b538SAndroid Build Coastguard Worker * Calculates the size of the object if it were serialized. 358*6777b538SAndroid Build Coastguard Worker * 359*6777b538SAndroid Build Coastguard Worker * This is not a cached value. If you are following a pattern like this: 360*6777b538SAndroid Build Coastguard Worker * 361*6777b538SAndroid Build Coastguard Worker * ``` 362*6777b538SAndroid Build Coastguard Worker * size_t size = [aMsg serializedSize]; 363*6777b538SAndroid Build Coastguard Worker * NSMutableData *foo = [NSMutableData dataWithCapacity:size + sizeof(size)]; 364*6777b538SAndroid Build Coastguard Worker * [foo writeSize:size]; 365*6777b538SAndroid Build Coastguard Worker * [foo appendData:[aMsg data]]; 366*6777b538SAndroid Build Coastguard Worker * ``` 367*6777b538SAndroid Build Coastguard Worker * 368*6777b538SAndroid Build Coastguard Worker * you would be better doing: 369*6777b538SAndroid Build Coastguard Worker * 370*6777b538SAndroid Build Coastguard Worker * ``` 371*6777b538SAndroid Build Coastguard Worker * NSData *data = [aMsg data]; 372*6777b538SAndroid Build Coastguard Worker * NSUInteger size = [aMsg length]; 373*6777b538SAndroid Build Coastguard Worker * NSMutableData *foo = [NSMutableData dataWithCapacity:size + sizeof(size)]; 374*6777b538SAndroid Build Coastguard Worker * [foo writeSize:size]; 375*6777b538SAndroid Build Coastguard Worker * [foo appendData:data]; 376*6777b538SAndroid Build Coastguard Worker * ``` 377*6777b538SAndroid Build Coastguard Worker * 378*6777b538SAndroid Build Coastguard Worker * @return The size of the message in it's binary representation. 379*6777b538SAndroid Build Coastguard Worker **/ 380*6777b538SAndroid Build Coastguard Worker - (size_t)serializedSize; 381*6777b538SAndroid Build Coastguard Worker 382*6777b538SAndroid Build Coastguard Worker /** 383*6777b538SAndroid Build Coastguard Worker * @return The descriptor for the message class. 384*6777b538SAndroid Build Coastguard Worker **/ 385*6777b538SAndroid Build Coastguard Worker + (GPBDescriptor *)descriptor; 386*6777b538SAndroid Build Coastguard Worker 387*6777b538SAndroid Build Coastguard Worker /** 388*6777b538SAndroid Build Coastguard Worker * Return the descriptor for the message. 389*6777b538SAndroid Build Coastguard Worker **/ 390*6777b538SAndroid Build Coastguard Worker - (GPBDescriptor *)descriptor; 391*6777b538SAndroid Build Coastguard Worker 392*6777b538SAndroid Build Coastguard Worker /** 393*6777b538SAndroid Build Coastguard Worker * @return An array with the extension descriptors that are currently set on the 394*6777b538SAndroid Build Coastguard Worker * message. 395*6777b538SAndroid Build Coastguard Worker **/ 396*6777b538SAndroid Build Coastguard Worker - (NSArray *)extensionsCurrentlySet; 397*6777b538SAndroid Build Coastguard Worker 398*6777b538SAndroid Build Coastguard Worker /** 399*6777b538SAndroid Build Coastguard Worker * Checks whether there is an extension set on the message which matches the 400*6777b538SAndroid Build Coastguard Worker * given extension descriptor. 401*6777b538SAndroid Build Coastguard Worker * 402*6777b538SAndroid Build Coastguard Worker * @param extension Extension descriptor to check if it's set on the message. 403*6777b538SAndroid Build Coastguard Worker * 404*6777b538SAndroid Build Coastguard Worker * @return Whether the extension is currently set on the message. 405*6777b538SAndroid Build Coastguard Worker **/ 406*6777b538SAndroid Build Coastguard Worker - (BOOL)hasExtension:(GPBExtensionDescriptor *)extension; 407*6777b538SAndroid Build Coastguard Worker 408*6777b538SAndroid Build Coastguard Worker /* 409*6777b538SAndroid Build Coastguard Worker * Fetches the given extension's value for this message. 410*6777b538SAndroid Build Coastguard Worker * 411*6777b538SAndroid Build Coastguard Worker * Extensions use boxed values (NSNumbers) for PODs and NSMutableArrays for 412*6777b538SAndroid Build Coastguard Worker * repeated fields. If the extension is a Message one will be auto created for 413*6777b538SAndroid Build Coastguard Worker * you and returned similar to fields. 414*6777b538SAndroid Build Coastguard Worker * 415*6777b538SAndroid Build Coastguard Worker * @param extension The extension descriptor of the extension to fetch. 416*6777b538SAndroid Build Coastguard Worker * 417*6777b538SAndroid Build Coastguard Worker * @return The extension matching the given descriptor, or nil if none found. 418*6777b538SAndroid Build Coastguard Worker **/ 419*6777b538SAndroid Build Coastguard Worker - (nullable id)getExtension:(GPBExtensionDescriptor *)extension; 420*6777b538SAndroid Build Coastguard Worker 421*6777b538SAndroid Build Coastguard Worker /** 422*6777b538SAndroid Build Coastguard Worker * Sets the given extension's value for this message. This only applies for 423*6777b538SAndroid Build Coastguard Worker * single field extensions (i.e. - not repeated fields). 424*6777b538SAndroid Build Coastguard Worker * 425*6777b538SAndroid Build Coastguard Worker * Extensions use boxed values (NSNumbers). 426*6777b538SAndroid Build Coastguard Worker * 427*6777b538SAndroid Build Coastguard Worker * @param extension The extension descriptor under which to set the value. 428*6777b538SAndroid Build Coastguard Worker * @param value The value to be set as the extension. 429*6777b538SAndroid Build Coastguard Worker **/ 430*6777b538SAndroid Build Coastguard Worker - (void)setExtension:(GPBExtensionDescriptor *)extension 431*6777b538SAndroid Build Coastguard Worker value:(nullable id)value; 432*6777b538SAndroid Build Coastguard Worker 433*6777b538SAndroid Build Coastguard Worker /** 434*6777b538SAndroid Build Coastguard Worker * Adds the given value to the extension for this message. This only applies 435*6777b538SAndroid Build Coastguard Worker * to repeated field extensions. If the field is a repeated POD type, the value 436*6777b538SAndroid Build Coastguard Worker * should be an NSNumber. 437*6777b538SAndroid Build Coastguard Worker * 438*6777b538SAndroid Build Coastguard Worker * @param extension The extension descriptor under which to add the value. 439*6777b538SAndroid Build Coastguard Worker * @param value The value to be added to the repeated extension. 440*6777b538SAndroid Build Coastguard Worker **/ 441*6777b538SAndroid Build Coastguard Worker - (void)addExtension:(GPBExtensionDescriptor *)extension value:(id)value; 442*6777b538SAndroid Build Coastguard Worker 443*6777b538SAndroid Build Coastguard Worker /** 444*6777b538SAndroid Build Coastguard Worker * Replaces the value at the given index with the given value for the extension 445*6777b538SAndroid Build Coastguard Worker * on this message. This only applies to repeated field extensions. If the field 446*6777b538SAndroid Build Coastguard Worker * is a repeated POD type, the value is should be an NSNumber. 447*6777b538SAndroid Build Coastguard Worker * 448*6777b538SAndroid Build Coastguard Worker * @param extension The extension descriptor under which to replace the value. 449*6777b538SAndroid Build Coastguard Worker * @param index The index of the extension to be replaced. 450*6777b538SAndroid Build Coastguard Worker * @param value The value to be replaced in the repeated extension. 451*6777b538SAndroid Build Coastguard Worker **/ 452*6777b538SAndroid Build Coastguard Worker - (void)setExtension:(GPBExtensionDescriptor *)extension 453*6777b538SAndroid Build Coastguard Worker index:(NSUInteger)index 454*6777b538SAndroid Build Coastguard Worker value:(id)value; 455*6777b538SAndroid Build Coastguard Worker 456*6777b538SAndroid Build Coastguard Worker /** 457*6777b538SAndroid Build Coastguard Worker * Clears the given extension for this message. 458*6777b538SAndroid Build Coastguard Worker * 459*6777b538SAndroid Build Coastguard Worker * @param extension The extension descriptor to be cleared from this message. 460*6777b538SAndroid Build Coastguard Worker **/ 461*6777b538SAndroid Build Coastguard Worker - (void)clearExtension:(GPBExtensionDescriptor *)extension; 462*6777b538SAndroid Build Coastguard Worker 463*6777b538SAndroid Build Coastguard Worker /** 464*6777b538SAndroid Build Coastguard Worker * Resets all of the fields of this message to their default values. 465*6777b538SAndroid Build Coastguard Worker **/ 466*6777b538SAndroid Build Coastguard Worker - (void)clear; 467*6777b538SAndroid Build Coastguard Worker 468*6777b538SAndroid Build Coastguard Worker @end 469*6777b538SAndroid Build Coastguard Worker 470*6777b538SAndroid Build Coastguard Worker NS_ASSUME_NONNULL_END 471