title: Introduction sidebar_position: 0 id: index license: | Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Binary Object Serialization reconstructs object graphs, including registered application types, collections, polymorphic values, and optional shared references.

Choose a mode

ModeUse it whenStart here
Xlang (default)Bytes cross runtime boundariesXlang Serialization
NativeEvery writer and reader uses the same runtime familyNative serialization

Xlang and native are the only object-serialization modes. Row Format is a random-access analytical representation, and Fory JSON is a Java JSON codec; use the format chooser when object reconstruction is not your goal.

Read the concepts and modes

Read these pages before choosing a runtime API:

  1. Core Concepts explains object graphs, types, schemas, references, polymorphism, and schema evolution across both modes.
  2. Xlang Serialization explains the portable format used by default and the rules that different language runtimes must share.
  3. Native Serialization explains when a same-runtime native format is appropriate.

Browse by runtime

Choose a runtime to find its installation route, lifecycle, exact APIs, configuration, type registration, schema behavior, extensions, platforms, and troubleshooting:

RuntimeModesDocumentation
Javaxlang and nativeJava runtime
Pythonxlang and nativePython runtime
C++xlang and nativeC++ runtime
Goxlang and nativeGo runtime
Rustxlang and nativeRust runtime
JavaScript/TypeScriptxlangJavaScript/TypeScript runtime
C#xlangC# runtime
SwiftxlangSwift runtime
DartxlangDart runtime
Scalaxlang and JVM nativeScala runtime
Kotlinxlang and JVM nativeKotlin runtime

Specifications