FlutterStandardReader Class Reference

#include <FlutterCodecs.h>

Inheritance diagram for FlutterStandardReader:

Instance Methods
(instancetype)	- initWithData:
(BOOL)	- hasMore
(UInt8)	- readByte
(void)	- readBytes:length:
(NSData *)	- readData:
(UInt32)	- readSize
(void)	- readAlignment:
(NSString *)	- readUTF8
(nullable id)	- readValue
(nullable id)	- readValueOfType:

Class Methods
(static CFTypeRef)	+ ReadValue [implementation]
(static CFTypeRef)	+ ReadTypedDataOfType [implementation]

Detailed Description

A reader of the Flutter standard binary encoding.

See FlutterStandardMessageCodec for details on the encoding.

The encoding is extensible via subclasses overriding readValueOfType.

Definition at line 132 of file FlutterCodecs.h.

Method Documentation

hasMore

- (BOOL) hasMore

Returns YES when the reader hasn't reached the end of its data.

Definition at line 356 of file FlutterStandardCodec.mm.

                {
  return _range.location < _data.length;
}

initWithData:

- (instancetype) initWithData:

(NSData*)

data

Create a new FlutterStandardReader who reads from data.

Definition at line 356 of file FlutterStandardCodec.mm.

                            :(NSData*)data {
  self = [super init];
  NSAssert(self, @"Super init cannot be nil");
  _data = [data copy];
  _range = NSMakeRange(0, 0);
  return self;
}

readAlignment:

- (void) readAlignment:

(UInt8)

alignment

Advances the read position until it is aligned with alignment.

Definition at line 356 of file FlutterStandardCodec.mm.

                     :(UInt8)alignment {
  FlutterStandardCodecHelperReadAlignment(&_range.location, alignment);
}

readByte

- (UInt8) readByte

Reads a byte value and increments the position.

Definition at line 356 of file FlutterStandardCodec.mm.

                  {
  return FlutterStandardCodecHelperReadByte(&_range.location, (__bridge CFDataRef)_data);
}

readBytes:length:

- (void) readBytes:		(void*)	destination
length:		(NSUInteger)	length

Reads a sequence of byte values of length and increments the position.

Definition at line 356 of file FlutterStandardCodec.mm.

                 :(void*)destination length:(NSUInteger)length {
  FlutterStandardCodecHelperReadBytes(&_range.location, length, destination,
                                      (__bridge CFDataRef)_data);
}

readData:

- (NSData *) readData:

(NSUInteger)

length

Reads a sequence of byte values of length and increments the position.

Definition at line 356 of file FlutterStandardCodec.mm.

                   :(NSUInteger)length {
  _range.length = length;
  NSData* data = [_data subdataWithRange:_range];
  _range.location += _range.length;
  return data;
}

readSize

- (UInt32) readSize

Reads a 32-bit unsigned integer representing a collection size and increments the position.

Definition at line 356 of file FlutterStandardCodec.mm.

                   {
  return FlutterStandardCodecHelperReadSize(&_range.location, (__bridge CFDataRef)_data);
}

ReadTypedDataOfType

+ (static CFTypeRef) ReadTypedDataOfType (FlutterStandardField)  field (CFTypeRef)  user_data

implementation

Definition at line 411 of file FlutterStandardCodec.mm.

                                                                                      {
  FlutterStandardReader* reader = (__bridge FlutterStandardReader*)user_data;
  unsigned long* location = &reader->_range.location;
  CFDataRef data = (__bridge CFDataRef)reader->_data;
  FlutterStandardDataType type = FlutterStandardDataTypeForField(field);
 
  UInt64 elementCount = FlutterStandardCodecHelperReadSize(location, data);
  UInt64 elementSize = elementSizeForFlutterStandardDataType(type);
  FlutterStandardCodecHelperReadAlignment(location, elementSize);
  UInt64 length = elementCount * elementSize;
  NSRange range = NSMakeRange(*location, length);
  // Note: subdataWithRange performs better than CFDataCreate and
  // CFDataCreateBytesNoCopy crashes.
  NSData* bytes = [(__bridge NSData*)data subdataWithRange:range];
  *location += length;
  return (__bridge CFTypeRef)[FlutterStandardTypedData typedDataWithData:bytes type:type];
}

readUTF8

- (NSString *) readUTF8

Read a null terminated string encoded with UTF-8/

Definition at line 356 of file FlutterStandardCodec.mm.

                      {
  return (__bridge NSString*)FlutterStandardCodecHelperReadUTF8(&_range.location,
                                                                (__bridge CFDataRef)_data);
}

readValue

- (nullable id) readValue

Reads a byte for FlutterStandardField the decodes a value matching that type.

See also: -[FlutterStandardWriter writeValue]

Definition at line 356 of file FlutterStandardCodec.mm.

                         {
  return (__bridge id)ReadValue((__bridge CFTypeRef)self);
}

ReadValue

+ (static CFTypeRef) ReadValue (CFTypeRef)  user_data

implementation

Definition at line 404 of file FlutterStandardCodec.mm.

                                                {
  FlutterStandardReader* reader = (__bridge FlutterStandardReader*)user_data;
  uint8_t type = FlutterStandardCodecHelperReadByte(&reader->_range.location,
                                                    (__bridge CFDataRef)reader->_data);
  return (__bridge CFTypeRef)[reader readValueOfType:type];
}

readValueOfType:

- (nullable id) readValueOfType:

(UInt8)

type

Decodes a value matching the type specified.

See also:

• FlutterStandardField
• -[FlutterStandardWriter writeValue]

Reimplemented in ExtendedReader.

Definition at line 411 of file FlutterStandardCodec.mm.

                              :(UInt8)type {
  return (__bridge id)FlutterStandardCodecHelperReadValueOfType(
      &_range.location, (__bridge CFDataRef)_data, type, ReadValue, ReadTypedDataOfType,
      (__bridge CFTypeRef)self);
}

---

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

• shell/platform/darwin/common/framework/Headers/FlutterCodecs.h
• shell/platform/darwin/common/framework/Source/FlutterStandardCodec.mm