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-site.git
commit a1ebe3a3d22df52ed999f183add264ae92c39ad9 Author: chaokunyang <[email protected]> AuthorDate: Sat May 9 07:15:19 2026 +0000 🔄 synced local 'docs/guide/' with remote 'docs/guide/' --- docs/guide/go/basic-serialization.md | 2 +- docs/guide/go/custom-serializers.md | 2 +- docs/guide/go/troubleshooting.md | 2 +- docs/guide/go/type-registration.md | 10 +++++----- docs/guide/python/cross-language.md | 2 +- docs/guide/rust/cross-language.md | 8 ++++---- docs/guide/rust/type-registration.md | 6 +++--- docs/guide/xlang/field-nullability.md | 2 +- docs/guide/xlang/getting-started.md | 4 ++-- docs/guide/xlang/serialization.md | 8 ++++---- 10 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/guide/go/basic-serialization.md b/docs/guide/go/basic-serialization.md index c0617783b2..8fc7779337 100644 --- a/docs/guide/go/basic-serialization.md +++ b/docs/guide/go/basic-serialization.md @@ -35,7 +35,7 @@ f.RegisterStruct(User{}, 1) f.RegisterStruct(Order{}, 2) // Or register with a name (more flexible, less prone to ID conflicts, but higher serialization cost) -f.RegisterNamedStruct(User{}, "example.User") +f.RegisterStructByName(User{}, "example.User") // Register enum types f.RegisterEnum(Color(0), 3) diff --git a/docs/guide/go/custom-serializers.md b/docs/guide/go/custom-serializers.md index b3db628e27..96849d55d7 100644 --- a/docs/guide/go/custom-serializers.md +++ b/docs/guide/go/custom-serializers.md @@ -242,7 +242,7 @@ f.RegisterExtension(MyType{}, 100, &MySerializer{}) More flexible but more serialization cost, type name included in serialized data: ```go -f.RegisterNamedExtension(MyType{}, "myapp.MyType", &MySerializer{}) +f.RegisterExtensionByName(MyType{}, "myapp.MyType", &MySerializer{}) ``` ## Best Practices diff --git a/docs/guide/go/troubleshooting.md b/docs/guide/go/troubleshooting.md index 529bba8df4..f87ce5fc25 100644 --- a/docs/guide/go/troubleshooting.md +++ b/docs/guide/go/troubleshooting.md @@ -280,7 +280,7 @@ Ensure the same field IDs are used across all languages for corresponding fields ```go // Go -f.RegisterNamedStruct(User{}, "example.User") +f.RegisterStructByName(User{}, "example.User") // Java - must match exactly fory.register(User.class, "example.User"); diff --git a/docs/guide/go/type-registration.md b/docs/guide/go/type-registration.md index 51425ec30d..edf5e5e114 100644 --- a/docs/guide/go/type-registration.md +++ b/docs/guide/go/type-registration.md @@ -58,7 +58,7 @@ Register a struct with a type name string. This is more flexible but has higher ```go f := fory.New() -err := f.RegisterNamedStruct(User{}, "example.User") +err := f.RegisterStructByName(User{}, "example.User") if err != nil { panic(err) } @@ -92,7 +92,7 @@ err := f.RegisterEnum(Status(0), 1) ### Register by Name ```go -err := f.RegisterNamedEnum(Status(0), "example.Status") +err := f.RegisterEnumByName(Status(0), "example.Status") ``` ## Extension Types @@ -106,7 +106,7 @@ f := fory.New() err := f.RegisterExtension(CustomType{}, 1, &CustomSerializer{}) // Or register by name -err = f.RegisterNamedExtension(CustomType{}, "example.Custom", &CustomSerializer{}) +err = f.RegisterExtensionByName(CustomType{}, "example.Custom", &CustomSerializer{}) ``` See [Custom Serializers](custom-serializers.md) for details on implementing the `ExtensionSerializer` interface. @@ -196,7 +196,7 @@ All languages use the same type name: **Go**: ```go -f.RegisterNamedStruct(User{}, "example.User") +f.RegisterStructByName(User{}, "example.User") ``` **Java**: @@ -223,7 +223,7 @@ struct User { } let mut fory = Fory::default(); -fory.register_by_name::<User>("example.User")?; +fory.register_by_name::<User>("example", "User")?; ``` ## Best Practices diff --git a/docs/guide/python/cross-language.md b/docs/guide/python/cross-language.md index 0022958245..ab8f5cab61 100644 --- a/docs/guide/python/cross-language.md +++ b/docs/guide/python/cross-language.md @@ -89,7 +89,7 @@ let mut fory = Fory::builder() .compatible(true) .xlang(true).build(); -fory.register_by_namespace::<Person>("example", "Person"); +fory.register_by_name::<Person>("example", "Person"); let person: Person = fory.deserialize(&binary_data)?; ``` diff --git a/docs/guide/rust/cross-language.md b/docs/guide/rust/cross-language.md index b95e1741bf..4223276a28 100644 --- a/docs/guide/rust/cross-language.md +++ b/docs/guide/rust/cross-language.md @@ -34,8 +34,8 @@ let mut fory = Fory::builder() // Register types with consistent IDs across languages fory.register::<MyStruct>(100); -// Or use namespace-based registration -fory.register_by_namespace::<MyStruct>("com.example", "MyStruct"); +// Or use name-based registration +fory.register_by_name::<MyStruct>("com.example", "MyStruct"); ``` ## Type Registration for Cross-Language @@ -52,12 +52,12 @@ let mut fory = Fory::builder() fory.register::<User>(100); // Same ID in Java, Python, etc. ``` -### Register by Namespace +### Register by Name For more flexible type naming: ```rust -fory.register_by_namespace::<User>("com.example", "User"); +fory.register_by_name::<User>("com.example", "User"); ``` ## Cross-Language Example diff --git a/docs/guide/rust/type-registration.md b/docs/guide/rust/type-registration.md index d2849ac881..0eedec6476 100644 --- a/docs/guide/rust/type-registration.md +++ b/docs/guide/rust/type-registration.md @@ -47,7 +47,7 @@ let bytes = fory.serialize(&user)?; let decoded: User = fory.deserialize(&bytes)?; ``` -## Register by Namespace +## Register by Name For cross-language compatibility, register with namespace and type name: @@ -56,8 +56,8 @@ let mut fory = Fory::builder() .compatible(true) .xlang(true).build(); -// Register with namespace-based naming -fory.register_by_namespace::<MyStruct>("com.example", "MyStruct")?; +// Register with symbolic type identity +fory.register_by_name::<MyStruct>("com.example", "MyStruct")?; ``` ## Register Custom Serializer diff --git a/docs/guide/xlang/field-nullability.md b/docs/guide/xlang/field-nullability.md index fc8d3736c9..5b9d645768 100644 --- a/docs/guide/xlang/field-nullability.md +++ b/docs/guide/xlang/field-nullability.md @@ -167,7 +167,7 @@ type Person struct { } fory := forygo.NewFory(forygo.WithXlang(true), forygo.WithCompatible(true)) -fory.RegisterNamedStruct(Person{}, "example.Person") +fory.RegisterStructByName(Person{}, "example.Person") ``` ### C++ diff --git a/docs/guide/xlang/getting-started.md b/docs/guide/xlang/getting-started.md index 7d091e3912..62f279b340 100644 --- a/docs/guide/xlang/getting-started.md +++ b/docs/guide/xlang/getting-started.md @@ -161,7 +161,7 @@ fory.register_type(Person, typename="example.Person") **Go:** ```go -fory.RegisterNamedStruct(Person{}, "example.Person") +fory.RegisterStructByName(Person{}, "example.Person") ``` **Rust:** @@ -177,7 +177,7 @@ struct Person { let mut fory = Fory::builder().xlang(true).compatible(true).build(); fory - .register_by_namespace::<Person>("example", "Person") + .register_by_name::<Person>("example", "Person") .expect("register Person"); ``` diff --git a/docs/guide/xlang/serialization.md b/docs/guide/xlang/serialization.md index aca6d3c250..68be9c5ef6 100644 --- a/docs/guide/xlang/serialization.md +++ b/docs/guide/xlang/serialization.md @@ -299,10 +299,10 @@ func main() { F12 []int16 } serializer := forygo.NewFory(forygo.WithXlang(true), forygo.WithCompatible(true)) - if err := serializer.RegisterNamedStruct(SomeClass1{}, "example.SomeClass1"); err != nil { + if err := serializer.RegisterStructByName(SomeClass1{}, "example.SomeClass1"); err != nil { panic(err) } - if err := serializer.RegisterNamedStruct(SomeClass2{}, "example.SomeClass2"); err != nil { + if err := serializer.RegisterStructByName(SomeClass2{}, "example.SomeClass2"); err != nil { panic(err) } obj1 := &SomeClass1{F1: true, F2: map[int8]int32{-1: 2}} @@ -410,10 +410,10 @@ fn complex_struct() { let mut fory = Fory::builder().xlang(true).compatible(true).build(); fory - .register_by_namespace::<Animal>("example", "foo2") + .register_by_name::<Animal>("example", "foo2") .expect("register Animal"); fory - .register_by_namespace::<Person>("example", "foo") + .register_by_name::<Person>("example", "foo") .expect("register Person"); let bin = fory.serialize(&person).expect("serialize success"); let obj: Person = fory.deserialize(&bin).expect("deserialize success"); --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
