This is an automated email from the ASF dual-hosted git repository.
chaokunyang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fory.git
The following commit(s) were added to refs/heads/main by this push:
new c95add6b docs: fix document markdown lint error (#2360)
c95add6b is described below
commit c95add6b616aeae363ec0b037aafca9c6181b91c
Author: LiangliangSui <[email protected]>
AuthorDate: Mon Jun 23 15:34:46 2025 +0800
docs: fix document markdown lint error (#2360)
<!--
**Thanks for contributing to Fory.**
**If this is your first time opening a PR on fory, you can refer to
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).**
Contribution Checklist
- The **Apache Fory (incubating)** community has restrictions on the
naming of pr titles. You can also find instructions in
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).
- Fory has a strong focus on performance. If the PR you submit will have
an impact on performance, please benchmark it first and provide the
benchmark result here.
-->
## What does this PR do?
<!-- Describe the purpose of this PR. -->
## Related issues
<!--
Is there any related issue? Please attach here.
- #xxxx0
- #xxxx1
- #xxxx2
-->
## Does this PR introduce any user-facing change?
<!--
If any user-facing interface changes, please [open an
issue](https://github.com/apache/fory/issues/new/choose) describing the
need to do so and update the document if necessary.
-->
- [ ] Does this PR introduce any public API change?
- [ ] Does this PR introduce any binary protocol compatibility change?
## Benchmark
<!--
When the PR has an impact on performance (if you don't know whether the
PR will have an impact on performance, you can submit the PR first, and
if it will have impact on performance, the code reviewer will explain
it), be sure to attach a benchmark data here.
-->
Signed-off-by: Liangliang Sui <[email protected]>
---
docs/guide/java_serialization_guide.md | 12 ------------
docs/specification/xlang_serialization_spec.md | 3 ---
2 files changed, 15 deletions(-)
diff --git a/docs/guide/java_serialization_guide.md
b/docs/guide/java_serialization_guide.md
index 5af400e4..33819ea7 100644
--- a/docs/guide/java_serialization_guide.md
+++ b/docs/guide/java_serialization_guide.md
@@ -314,7 +314,6 @@ The key difference between these two is that
`AbstractCollectionSerializer` can
For collection serializer, this is a special parameter `supportCodegenHook`
needs be configured:
- When `true`:
-
- Enables optimized access to collection elements and JIT compilation for
better performance
- Direct serialization invocation and inline for map key-value items without
dynamic serializer dispatch cost.
- Better performance for standard collection types
@@ -487,21 +486,18 @@ class IntListSerializer extends
AbstractCollectionSerializer<IntList> {
Key Points:
1. **Primitive Array Storage**:
-
- Uses `int[]` for direct storage
- Avoids boxing/unboxing overhead
- Provides efficient memory layout
- Enables direct array access
2. **Direct Serialization**:
-
- Write size first
- Write primitive values directly
- No iteration overhead
- No boxing/unboxing during serialization
3. **Direct Deserialization**:
-
- Read size first
- Create primitive array
- Read values directly into array
@@ -676,21 +672,18 @@ class CustomCollectionSerializer extends
AbstractCollectionSerializer<CustomColl
Key takeways:
1. **Collection Structure**:
-
- Array-based storage for elements
- Fixed size after creation
- Direct element access
- Size tracking
2. **View Implementation**:
-
- Extends `AbstractCollection` for simplicity
- Provides iterator for element access
- Implements `add()` for deserialization
- Shares array reference with original type
3. **Serializer Features**:
-
- Uses `supportCodegenHook=true` for JIT optimization
- Shares array references when possible
- Maintains proper size tracking
@@ -711,7 +704,6 @@ When implementing a serializer for a custom Map type, you
must extend `MapSerial
Similiar to collection serializer, this is a special parameter
`supportCodegenHook` needs be configured:
- When `true`:
-
- Enables optimized access to map elements and JIT compilation for better
performance
- Direct serialization invocation and inline for map key-value items without
dynamic serializer dispatch cost.
- Better performance for standard map types
@@ -857,21 +849,18 @@ class FixedValueMapSerializer extends
AbstractMapSerializer<FixedValueMap> {
Key Points:
1. **Disable Codegen**:
-
- Set `supportCodegenHook=false` in constructor
- Fory will use your `write`/`read` methods directly
- No JIT optimization will be applied
- Full control over serialization format
2. **Write Method**:
-
- Handle all serialization manually
- Write custom fields first
- Write map entries in your preferred format
- Control the exact binary layout
3. **Read Method**:
-
- Handle all deserialization manually
- Read in same order as written
- Create and populate map instance
@@ -892,7 +881,6 @@ When to Use: this approach is best when
Trade-offs
1. **Advantages**:
-
- Complete control over serialization
- Custom binary format possible
- Simpler implementation for special cases
diff --git a/docs/specification/xlang_serialization_spec.md
b/docs/specification/xlang_serialization_spec.md
index debfaf92..58ac5778 100644
--- a/docs/specification/xlang_serialization_spec.md
+++ b/docs/specification/xlang_serialization_spec.md
@@ -252,12 +252,10 @@ If schema evolution mode is enabled globally when
creating fory, and enabled for
using one of the following mode. Which mode to use is configured when creating
fory.
- Normal mode(meta share not enabled):
-
- If type meta hasn't been written before, add `type def`
to `captured_type_defs`: `captured_type_defs[type def] = map size`.
- Get index of the meta in `captured_type_defs`, write that index as `|
unsigned varint: index |`.
- After finished the serialization of the object graph, fory will start to
write `captured_type_defs`:
-
- Firstly, set current to `meta start offset` of fory header
- Then write `captured_type_defs` one by one:
@@ -284,7 +282,6 @@ using one of the following mode. Which mode to use is
configured when creating f
```
- Streaming mode(streaming mode doesn't support meta share):
-
- If type meta hasn't been written before, the data will be written as:
```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
