Files
react-native/ReactCommon/react/renderer/mapbuffer/MapBuffer.h
T
Andrei Shikov f33892081a Cleanup ReadableMapBuffer
Summary:
Cleans up `ReadableMapBuffer` APIs and migrates to use `std::vector` instead of raw pointer array.

Also uses `fbjni` utility to allocate the bytes instead of making manual JNI calls.

Changelog: [Internal]

Reviewed By: sammy-SC

Differential Revision: D33513027

fbshipit-source-id: afe7d320d12830503de4c9994117d849f0b25245
2022-01-12 08:13:32 -08:00

80 lines
2.1 KiB
C++

/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#pragma once
#include <react/debug/react_native_assert.h>
#include <react/renderer/mapbuffer/primitives.h>
#include <limits>
namespace facebook {
namespace react {
class ReadableMapBuffer;
/**
* MapBuffer is an optimized map format for transferring data like props between
* C++ and other platforms The implementation of this map is optimized to:
* - be compact to optimize space when sparse (sparse is the common case).
* - be accessible through JNI with zero/minimal copying via ByteBuffer.
* - be Have excellent C++ single-write and many-read performance by maximizing
* CPU cache performance through compactness, data locality, and fixed offsets
* where possible.
* - be optimized for iteration and intersection against other maps, but with
* reasonably good random access as well.
* - Work recursively for nested maps/arrays.
* - Supports dynamic types that map to JSON.
* - Don't require mutability - single-write on creation.
* - have minimal APK size and build time impact.
*/
class MapBuffer {
friend ReadableMapBuffer;
private:
// Buffer and its size
std::vector<uint8_t> const bytes_;
// amount of items in the MapBuffer
uint16_t count_ = 0;
// returns the relative offset of the first byte of dynamic data
int32_t getDynamicDataOffset() const;
public:
explicit MapBuffer(std::vector<uint8_t> data);
MapBuffer(MapBuffer const &buffer) = delete;
MapBuffer &operator=(MapBuffer other) = delete;
MapBuffer(MapBuffer &&buffer) = default;
int32_t getInt(Key key) const;
bool getBool(Key key) const;
double getDouble(Key key) const;
std::string getString(Key key) const;
// TODO T83483191: review this declaration
MapBuffer getMapBuffer(Key key) const;
int32_t getBufferSize() const;
// TODO T83483191: review parameters of copy method
void copy(uint8_t *output) const;
bool isNull(Key key) const;
uint16_t getCount() const;
};
} // namespace react
} // namespace facebook