objectivec/GPBUnknownField.h

   1 // Protocol Buffers - Google's data interchange format
   2 // Copyright 2008 Google Inc.  All rights reserved.
   3 //
   4 // Use of this source code is governed by a BSD-style
   5 // license that can be found in the LICENSE file or at
   6 // https://developers.google.com/open-source/licenses/bsd
   7
   8 #import <Foundation/Foundation.h>
   9
  10 #import "GPBArray.h"
  11 #import "GPBUnknownFields.h"
  12
  13 @class GPBUnknownFields;
  14
  15 NS_ASSUME_NONNULL_BEGIN
  16
  17 typedef NS_ENUM(uint8_t, GPBUnknownFieldType) {
  18   GPBUnknownFieldTypeVarint,
  19   GPBUnknownFieldTypeFixed32,
  20   GPBUnknownFieldTypeFixed64,
  21   GPBUnknownFieldTypeLengthDelimited,  // Length prefixed
  22   GPBUnknownFieldTypeGroup,            // Tag delimited
  23 };
  24
  25 /**
  26  * Store an unknown field. These are used in conjunction with GPBUnknownFields.
  27  **/
  28 __attribute__((objc_subclassing_restricted))
  29 @interface GPBUnknownField : NSObject<NSCopying>
  30
  31 /** The field number the data is stored under. */
  32 @property(nonatomic, readonly, assign) int32_t number;
  33
  34 /** The type of the field. */
  35 @property(nonatomic, readonly, assign) GPBUnknownFieldType type;
  36
  37 /**
  38  * Fetch the varint value.
  39  *
  40  * It is a programming error to call this when the `type` is not a varint.
  41  */
  42 @property(nonatomic, readonly, assign) uint64_t varint;
  43
  44 /**
  45  * Fetch the fixed32 value.
  46  *
  47  * It is a programming error to call this when the `type` is not a fixed32.
  48  */
  49 @property(nonatomic, readonly, assign) uint32_t fixed32;
  50
  51 /**
  52  * Fetch the fixed64 value.
  53  *
  54  * It is a programming error to call this when the `type` is not a fixed64.
  55  */
  56 @property(nonatomic, readonly, assign) uint64_t fixed64;
  57
  58 /**
  59  * Fetch the length delimited (length prefixed) value.
  60  *
  61  * It is a programming error to call this when the `type` is not a length
  62  * delimited.
  63  */
  64 @property(nonatomic, readonly, strong, nonnull) NSData *lengthDelimited;
  65
  66 /**
  67  * Fetch the group (tag delimited) value.
  68  *
  69  * It is a programming error to call this when the `type` is not a group.
  70  */
  71 @property(nonatomic, readonly, strong, nonnull) GPBUnknownFields *group;
  72
  73 @end
  74
  75 NS_ASSUME_NONNULL_END