protobuf/objectivec/GPBCodedInputStream.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>
 
@class GPBMessage;
@class GPBExtensionRegistry;
 
NS_ASSUME_NONNULL_BEGIN
 
CF_EXTERN_C_BEGIN
 
extern NSString *const GPBCodedInputStreamException;
 
extern NSString *const GPBCodedInputStreamUnderlyingErrorKey;
 
extern NSString *const GPBCodedInputStreamErrorDomain;
 
typedef NS_ENUM(NSInteger, GPBCodedInputStreamErrorCode) {
  GPBCodedInputStreamErrorInvalidSize = -100,
  GPBCodedInputStreamErrorSubsectionLimitReached = -101,
  GPBCodedInputStreamErrorInvalidSubsectionLimit = -102,
  GPBCodedInputStreamErrorInvalidTag = -103,
  GPBCodedInputStreamErrorInvalidUTF8 = -104,
  GPBCodedInputStreamErrorInvalidVarInt = -105,
  GPBCodedInputStreamErrorRecursionDepthExceeded = -106,
};
 
CF_EXTERN_C_END
 
@interface GPBCodedInputStream : NSObject
 
+ (instancetype)streamWithData:(NSData *)data;
 
- (instancetype)initWithData:(NSData *)data;
 
- (int32_t)readTag;
 
- (double)readDouble;
- (float)readFloat;
- (uint64_t)readUInt64;
- (uint32_t)readUInt32;
- (int64_t)readInt64;
- (int32_t)readInt32;
- (uint64_t)readFixed64;
- (uint32_t)readFixed32;
- (int32_t)readEnum;
- (int32_t)readSFixed32;
- (int64_t)readSFixed64;
- (int32_t)readSInt32;
- (int64_t)readSInt64;
- (BOOL)readBool;
- (NSString *)readString;
- (NSData *)readBytes;
 
- (void)readMessage:(GPBMessage *)message
  extensionRegistry:(nullable GPBExtensionRegistry *)extensionRegistry;
 
- (BOOL)skipField:(int32_t)tag;
 
- (void)skipMessage;
 
- (BOOL)isAtEnd;
 
- (size_t)position;
 
- (size_t)pushLimit:(size_t)byteLimit;
 
- (void)popLimit:(size_t)oldLimit;
 
- (void)checkLastTagWas:(int32_t)expected;
 
@end
 
NS_ASSUME_NONNULL_END