Skip to main content
Version: dev

C++ Setup

Fory C++ provides binary Object Serialization, Row Format, generated models, and Fory gRPC. It requires a C++17 compiler and supports CMake 3.16 or later and Bazel 8 or later.

Verify the Toolchain​

c++ --version
cmake --version
# or: bazel --version

Object Serialization​

Use xlang mode for data shared with Fory implementations in other languages or native mode for C++-only data. Fetch a released source tree and link the serialization target:

CMakeLists.txt
cmake_minimum_required(VERSION 3.16)
project(fory_example LANGUAGES CXX)

set(CMAKE_CXX_STANDARD 17)
include(FetchContent)
FetchContent_Declare(
  fory
  GIT_REPOSITORY https://github.com/apache/fory.git
  GIT_TAG v1.5.0
  SOURCE_SUBDIR cpp
)
FetchContent_MakeAvailable(fory)

add_executable(fory_example main.cc)
target_link_libraries(fory_example PRIVATE fory::serialization)
main.cc
#include <cassert>
#include <cstdint>
#include <string>
#include <utility>
#include <vector>

#include "fory/serialization/fory.h"

struct User {
  int64_t id;
  std::string name;

  bool operator==(const User &other) const {
    return id == other.id && name == other.name;
  }
};
FORY_STRUCT(User, id, name);

int main() {
  auto fory = fory::serialization::Fory::builder().xlang(true).build();
  fory.register_struct<User>(1);

  auto bytes = fory.serialize(User{1, "Alice"});
  assert(bytes.ok());
  std::vector<uint8_t> data = std::move(bytes).value();
  auto decoded = fory.deserialize<User>(data);
  assert(decoded.ok());
  User user = std::move(decoded).value();
  assert(user.id == 1 && user.name == "Alice");
}
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --parallel
./build/fory_example

See C++ Object Serialization for Bazel, Windows, error handling, and thread-safe instances; then continue to xlang or native mode.

Other Capabilities​