protobuf/objectivec/GPBMessage.h

Go to the documentation of this file.

// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
#import <Foundation/Foundation.h>
 
#import "GPBBootstrap.h"
 
@class GPBDescriptor;
@class GPBCodedInputStream;
@class GPBCodedOutputStream;
@class GPBExtensionDescriptor;
@class GPBExtensionRegistry;
@class GPBFieldDescriptor;
@class GPBUnknownFieldSet;
 
NS_ASSUME_NONNULL_BEGIN
 
CF_EXTERN_C_BEGIN
 
extern NSString *const GPBMessageErrorDomain;
 
typedef NS_ENUM(NSInteger, GPBMessageErrorCode) {
  GPBMessageErrorCodeOther = -100,
  GPBMessageErrorCodeMissingRequiredField = -101,
};
 
extern NSString *const GPBErrorReasonKey;
 
CF_EXTERN_C_END
 
@interface GPBMessage : NSObject<NSSecureCoding, NSCopying>
 
// If you add an instance method/property to this class that may conflict with
// fields declared in protos, you need to update objective_helpers.cc. The main
// cases are methods that take no arguments, or setFoo:/hasFoo: type methods.
 
@property(nonatomic, copy, nullable) GPBUnknownFieldSet *unknownFields;
 
@property(nonatomic, readonly, getter=isInitialized) BOOL initialized;
 
+ (instancetype)message;
 
+ (nullable instancetype)parseFromData:(NSData *)data error:(NSError **)errorPtr;
 
+ (nullable instancetype)parseFromData:(NSData *)data
                     extensionRegistry:(nullable GPBExtensionRegistry *)extensionRegistry
                                 error:(NSError **)errorPtr;
 
+ (nullable instancetype)parseFromCodedInputStream:(GPBCodedInputStream *)input
                                 extensionRegistry:
                                     (nullable GPBExtensionRegistry *)extensionRegistry
                                             error:(NSError **)errorPtr;
 
+ (nullable instancetype)parseDelimitedFromCodedInputStream:(GPBCodedInputStream *)input
                                          extensionRegistry:
                                              (nullable GPBExtensionRegistry *)extensionRegistry
                                                      error:(NSError **)errorPtr;
 
- (nullable instancetype)initWithData:(NSData *)data error:(NSError **)errorPtr;
 
- (nullable instancetype)initWithData:(NSData *)data
                    extensionRegistry:(nullable GPBExtensionRegistry *)extensionRegistry
                                error:(NSError **)errorPtr;
 
- (nullable instancetype)initWithCodedInputStream:(GPBCodedInputStream *)input
                                extensionRegistry:
                                    (nullable GPBExtensionRegistry *)extensionRegistry
                                            error:(NSError **)errorPtr;
 
- (void)mergeFromData:(NSData *)data
    extensionRegistry:(nullable GPBExtensionRegistry *)extensionRegistry;
 
- (void)mergeFrom:(GPBMessage *)other;
 
- (void)writeToCodedOutputStream:(GPBCodedOutputStream *)output;
 
- (void)writeToOutputStream:(NSOutputStream *)output;
 
- (void)writeDelimitedToCodedOutputStream:(GPBCodedOutputStream *)output;
 
- (void)writeDelimitedToOutputStream:(NSOutputStream *)output;
 
- (nullable NSData *)data;
 
- (NSData *)delimitedData;
 
- (size_t)serializedSize;
 
+ (GPBDescriptor *)descriptor;
 
- (GPBDescriptor *)descriptor;
 
- (NSArray *)extensionsCurrentlySet;
 
- (BOOL)hasExtension:(GPBExtensionDescriptor *)extension;
 
/*
 * Fetches the given extension's value for this message.
 *
 * Extensions use boxed values (NSNumbers) for PODs and NSMutableArrays for
 * repeated fields. If the extension is a Message one will be auto created for
 * you and returned similar to fields.
 *
 * @param extension The extension descriptor of the extension to fetch.
 *
 * @return The extension matching the given descriptor, or nil if none found.
 **/
- (nullable id)getExtension:(GPBExtensionDescriptor *)extension;
 
- (void)setExtension:(GPBExtensionDescriptor *)extension
               value:(nullable id)value;
 
- (void)addExtension:(GPBExtensionDescriptor *)extension value:(id)value;
 
- (void)setExtension:(GPBExtensionDescriptor *)extension
               index:(NSUInteger)index
               value:(id)value;
 
- (void)clearExtension:(GPBExtensionDescriptor *)extension;
 
- (void)clear;
 
@end
 
NS_ASSUME_NONNULL_END