1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189---
title: Syntax Reference
sidebar_position: 2
id: syntax
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.
---
This document provides a complete reference for the Fory Definition Language (FDL) syntax.
## File Structure
An FDL file consists of:
1. Optional package declaration
2. Optional import statements
3. Type definitions (enums and messages)
```protobuf
// Optional package declaration
package com.example.models;
// Import statements
import "common/types.fdl";
// Type definitions
enum Color [id=100] { ... }
message User [id=101] { ... }
message Order [id=102] { ... }
```
## Comments
FDL supports both single-line and block comments:
```protobuf
// This is a single-line comment
/*
* This is a block comment
* that spans multiple lines
*/
message Example {
string name = 1; // Inline comment
}
```
## Package Declaration
The package declaration defines the namespace for all types in the file.
```protobuf
package com.example.models;
```
**Rules:**
- Optional but recommended
- Must appear before any type definitions
- Only one package declaration per file
- Used for namespace-based type registration
**Language Mapping:**
| Language | Package Usage |
| -------- | --------------------------------- |
| Java | Java package |
| Python | Module name (dots to underscores) |
| Go | Package name (last component) |
| Rust | Module name (dots to underscores) |
| C++ | Namespace (dots to `::`) |
## File-Level Options
Options can be specified at file level to control language-specific code generation.
### Syntax
```protobuf
option option_name = value;
```
### Java Package Option
Override the Java package for generated code:
```protobuf
package payment;
option java_package = "com.mycorp.payment.v1";
message Payment {
string id = 1;
}
```
**Effect:**
- Generated Java files will be in `com/mycorp/payment/v1/` directory
- Java package declaration will be `package com.mycorp.payment.v1;`
- Type registration still uses the FDL package (`payment`) for cross-language compatibility
### Go Package Option
Specify the Go import path and package name:
```protobuf
package payment;
option go_package = "github.com/mycorp/apis/gen/payment/v1;paymentv1";
message Payment {
string id = 1;
}
```
**Format:** `"import/path;package_name"` or just `"import/path"` (last segment used as package name)
**Effect:**
- Generated Go files will have `package paymentv1`
- The import path can be used in other Go code
- Type registration still uses the FDL package (`payment`) for cross-language compatibility
### Java Outer Classname Option
Generate all types as inner classes of a single outer wrapper class:
```protobuf
package payment;
option java_outer_classname = "DescriptorProtos";
enum Status {
UNKNOWN = 0;
ACTIVE = 1;
}
message Payment {
string id = 1;
Status status = 2;
}
```
**Effect:**
- Generates a single file `DescriptorProtos.java` instead of separate files
- All enums and messages become `public static` inner classes
- The outer class is `public final` with a private constructor
- Useful for grouping related types together
**Generated structure:**
```java
public final class DescriptorProtos {
private DescriptorProtos() {}
public static enum Status {
UNKNOWN,
ACTIVE;
}
public static class Payment {
private String id;
private Status status;
// ...
}
}
```
**Combined with java_package:**
```protobuf
package payment;
option java_package = "com.example.proto";
option java_outer_classname = "PaymentProtos";
message Payment {
string id = 1;
}
```
This generates `com/example/proto/PaymentProtos.java` with all types as inner classes.
### Java Multiple Files Option
Control whether types are generated in separate files or as inner classes:
```protobuf
package payment;
option java_outer_classname = "PaymentProtos";
option java_multiple_files = true;
message Payment {
string id = 1;
}
message Receipt {
string id = 1;
}
```
**Behavior:**
| `java_outer_classname` | `java_multiple_files` | Result |
| ---------------------- | --------------------- | ------------------------------------------- |
| Not set | Any | Separate files (one per type) |
| Set | `false` (default) | Single file with all types as inner classes |
| Set | `true` | Separate files (overrides outer class) |
**Effect of `java_multiple_files = true`:**
- Each top-level enum and message gets its own `.java` file
- Overrides `java_outer_classname` behavior
- Useful when you want separate files but still specify an outer class name for other purposes
**Example without java_multiple_files (default):**
```protobuf
option java_outer_classname = "PaymentProtos";
// Generates: PaymentProtos.java containing Payment and Receipt as inner classes
```
**Example with java_multiple_files = true:**
```protobuf
option java_outer_classname = "PaymentProtos";
option java_multiple_files = true;
// Generates: Payment.java, Receipt.java (separate files)
```
### Multiple Options
Multiple options can be specified:
```protobuf
package payment;
option java_package = "com.mycorp.payment.v1";
option go_package = "github.com/mycorp/apis/gen/payment/v1;paymentv1";
option deprecated = true;
message Payment {
string id = 1;
}
```
### Fory Extension Options
FDL supports protobuf-style extension options for Fory-specific configuration:
```protobuf
option (fory).use_record_for_java_message = true;
option (fory).polymorphism = true;
```
**Available File Options:**
| Option | Type | Description |
| ----------------------------- | ------ | ------------------------------------------------------------ |
| `use_record_for_java_message` | bool | Generate Java records instead of classes |
| `polymorphism` | bool | Enable polymorphism for all types |
| `go_nested_type_style` | string | Go nested type naming: `underscore` (default) or `camelcase` |
See the [Fory Extension Options](#fory-extension-options) section for complete documentation of message, enum, and field options.
### Option Priority
For language-specific packages:
1. Command-line package override (highest priority)
2. Language-specific option (`java_package`, `go_package`)
3. FDL package declaration (fallback)
**Example:**
```protobuf
package myapp.models;
option java_package = "com.example.generated";
```
| Scenario | Java Package Used |
| ------------------------- | ------------------------- |
| No override | `com.example.generated` |
| CLI: `--package=override` | `override` |
| No java_package option | `myapp.models` (fallback) |
### Cross-Language Type Registration
Language-specific options only affect where code is generated, not the type namespace used for serialization. This ensures cross-language compatibility:
```protobuf
package myapp.models;
option java_package = "com.mycorp.generated";
option go_package = "github.com/mycorp/gen;genmodels";
message User {
string name = 1;
}
```
All languages will register `User` with namespace `myapp.models`, enabling:
- Java serialized data → Go deserialization
- Go serialized data → Java deserialization
- Any language combination works seamlessly
## Import Statement
Import statements allow you to use types defined in other FDL files.
### Basic Syntax
```protobuf
import "path/to/file.fdl";
```
### Multiple Imports
```protobuf
import "common/types.fdl";
import "common/enums.fdl";
import "models/address.fdl";
```
### Path Resolution
Import paths are resolved relative to the importing file:
```
project/
├── common/
│ └── types.fdl
├── models/
│ ├── user.fdl # import "../common/types.fdl"
│ └── order.fdl # import "../common/types.fdl"
└── main.fdl # import "common/types.fdl"
```
**Rules:**
- Import paths are quoted strings (double or single quotes)
- Paths are resolved relative to the importing file's directory
- Imported types become available as if defined in the current file
- Circular imports are detected and reported as errors
- Transitive imports work (if A imports B and B imports C, A has access to C's types)
### Complete Example
**common/types.fdl:**
```protobuf
package common;
enum Status [id=100] {
PENDING = 0;
ACTIVE = 1;
COMPLETED = 2;
}
message Address [id=101] {
string street = 1;
string city = 2;
string country = 3;
}
```
**models/user.fdl:**
```protobuf
package models;
import "../common/types.fdl";
message User [id=200] {
string id = 1;
string name = 2;
Address home_address = 3; // Uses imported type
Status status = 4; // Uses imported enum
}
```
### Unsupported Import Syntax
The following protobuf import modifiers are **not supported**:
```protobuf
// NOT SUPPORTED - will produce an error
import public "other.fdl";
import weak "other.fdl";
```
**`import public`**: FDL uses a simpler import model. All imported types are available to the importing file only. Re-exporting is not supported. Import each file directly where needed.
**`import weak`**: FDL requires all imports to be present at compile time. Optional dependencies are not supported.
### Import Errors
The compiler reports errors for:
- **File not found**: The imported file doesn't exist
- **Circular import**: A imports B which imports A (directly or indirectly)
- **Parse errors**: Syntax errors in imported files
- **Unsupported syntax**: `import public` or `import weak`
## Enum Definition
Enums define a set of named integer constants.
### Basic Syntax
```protobuf
enum Status {
PENDING = 0;
ACTIVE = 1;
COMPLETED = 2;
}
```
### With Type ID
```protobuf
enum Status [id=100] {
PENDING = 0;
ACTIVE = 1;
COMPLETED = 2;
}
```
### Reserved Values
Reserve field numbers or names to prevent reuse:
```protobuf
enum Status {
reserved 2, 15, 9 to 11, 40 to max; // Reserved numbers
reserved "OLD_STATUS", "DEPRECATED"; // Reserved names
PENDING = 0;
ACTIVE = 1;
COMPLETED = 3;
}
```
### Enum Options
Options can be specified within enums:
```protobuf
enum Status {
option deprecated = true; // Allowed
PENDING = 0;
ACTIVE = 1;
}
```
**Forbidden Options:**
- `option allow_alias = true` is **not supported**. Each enum value must have a unique integer.
### Enum Prefix Stripping
When enum values use a protobuf-style prefix (enum name in UPPER_SNAKE_CASE), the compiler automatically strips the prefix for languages with scoped enums:
```protobuf
// Input with prefix
enum DeviceTier {
DEVICE_TIER_UNKNOWN = 0;
DEVICE_TIER_TIER1 = 1;
DEVICE_TIER_TIER2 = 2;
}
```
**Generated code:**
| Language | Output | Style |
| -------- | ----------------------------------------- | -------------- |
| Java | `UNKNOWN, TIER1, TIER2` | Scoped enum |
| Rust | `Unknown, Tier1, Tier2` | Scoped enum |
| C++ | `UNKNOWN, TIER1, TIER2` | Scoped enum |
| Python | `UNKNOWN, TIER1, TIER2` | Scoped IntEnum |
| Go | `DeviceTierUnknown, DeviceTierTier1, ...` | Unscoped const |
**Note:** The prefix is only stripped if the remainder is a valid identifier. For example, `DEVICE_TIER_1` is kept unchanged because `1` is not a valid identifier name.
**Grammar:**
```
enum_def := 'enum' IDENTIFIER [type_options] '{' enum_body '}'
type_options := '[' type_option (',' type_option)* ']'
type_option := IDENTIFIER '=' option_value
enum_body := (option_stmt | reserved_stmt | enum_value)*
option_stmt := 'option' IDENTIFIER '=' option_value ';'
reserved_stmt := 'reserved' reserved_items ';'
enum_value := IDENTIFIER '=' INTEGER ';'
```
**Rules:**
- Enum names must be unique within the file
- Enum values must have explicit integer assignments
- Value integers must be unique within the enum (no aliases)
- Type ID (`[id=100]`) is optional but recommended for cross-language use
**Example with All Features:**
```protobuf
// HTTP status code categories
enum HttpCategory [id=200] {
reserved 10 to 20; // Reserved for future use
reserved "UNKNOWN"; // Reserved name
INFORMATIONAL = 1;
SUCCESS = 2;
REDIRECTION = 3;
CLIENT_ERROR = 4;
SERVER_ERROR = 5;
}
```
## Message Definition
Messages define structured data types with typed fields.
### Basic Syntax
```protobuf
message Person {
string name = 1;
int32 age = 2;
}
```
### With Type ID
```protobuf
message Person [id=101] {
string name = 1;
int32 age = 2;
}
```
### Reserved Fields
Reserve field numbers or names to prevent reuse after removing fields:
```protobuf
message User {
reserved 2, 15, 9 to 11; // Reserved field numbers
reserved "old_field", "temp"; // Reserved field names
string id = 1;
string name = 3;
}
```
### Message Options
Options can be specified within messages:
```protobuf
message User {
option deprecated = true;
string id = 1;
string name = 2;
}
```
**Grammar:**
```
message_def := 'message' IDENTIFIER [type_options] '{' message_body '}'
type_options := '[' type_option (',' type_option)* ']'
type_option := IDENTIFIER '=' option_value
message_body := (option_stmt | reserved_stmt | nested_type | field_def)*
nested_type := enum_def | message_def
```
## Nested Types
Messages can contain nested message and enum definitions. This is useful for defining types that are closely related to their parent message.
### Nested Messages
```protobuf
message SearchResponse {
message Result {
string url = 1;
string title = 2;
repeated string snippets = 3;
}
repeated Result results = 1;
}
```
### Nested Enums
```protobuf
message Container {
enum Status {
STATUS_UNKNOWN = 0;
STATUS_ACTIVE = 1;
STATUS_INACTIVE = 2;
}
Status status = 1;
}
```
### Qualified Type Names
Nested types can be referenced from other messages using qualified names (Parent.Child):
```protobuf
message SearchResponse {
message Result {
string url = 1;
string title = 2;
}
}
message SearchResultCache {
// Reference nested type with qualified name
SearchResponse.Result cached_result = 1;
repeated SearchResponse.Result all_results = 2;
}
```
### Deeply Nested Types
Nesting can be multiple levels deep:
```protobuf
message Outer {
message Middle {
message Inner {
string value = 1;
}
Inner inner = 1;
}
Middle middle = 1;
}
message OtherMessage {
// Reference deeply nested type
Outer.Middle.Inner deep_ref = 1;
}
```
### Language-Specific Generation
| Language | Nested Type Generation |
| -------- | --------------------------------------------------------------------------------- |
| Java | Static inner classes (`SearchResponse.Result`) |
| Python | Nested classes within dataclass |
| Go | Flat structs with underscore (`SearchResponse_Result`, configurable to camelcase) |
| Rust | Nested modules (`search_response::Result`) |
| C++ | Nested classes (`SearchResponse::Result`) |
**Note:** Go defaults to underscore-separated nested names; set `option (fory).go_nested_type_style = "camelcase";` to use concatenated names. Rust emits nested modules for nested types.
### Nested Type Rules
- Nested type names must be unique within their parent message
- Nested types can have their own type IDs
- Type IDs must be globally unique (including nested types)
- Within a message, you can reference nested types by simple name
- From outside, use the qualified name (Parent.Child)
## Field Definition
Fields define the properties of a message.
### Basic Syntax
```protobuf
field_type field_name = field_number;
```
### With Modifiers
```protobuf
optional repeated string tags = 1; // Nullable list
repeated optional string tags = 2; // Elements may be null
ref repeated Node nodes = 3; // Collection tracked as a reference
repeated ref Node nodes = 4; // Elements tracked as references
```
**Grammar:**
```
field_def := [modifiers] field_type IDENTIFIER '=' INTEGER ';'
modifiers := { 'optional' | 'ref' } ['repeated' { 'optional' | 'ref' }]
field_type := primitive_type | named_type | map_type
```
Modifiers before `repeated` apply to the field/collection. Modifiers after
`repeated` apply to list elements.
### Field Modifiers
#### `optional`
Marks the field as nullable:
```protobuf
message User {
string name = 1; // Required, non-null
optional string email = 2; // Nullable
}
```
**Generated Code:**
| Language | Non-optional | Optional |
| -------- | ------------------ | ----------------------------------------------- |
| Java | `String name` | `String email` with `@ForyField(nullable=true)` |
| Python | `name: str` | `name: Optional[str]` |
| Go | `Name string` | `Name *string` |
| Rust | `name: String` | `name: Option<String>` |
| C++ | `std::string name` | `std::optional<std::string> name` |
#### `ref`
Enables reference tracking for shared/circular references:
```protobuf
message Node {
string value = 1;
ref Node parent = 2; // Can point to shared object
repeated ref Node children = 3;
}
```
**Use Cases:**
- Shared objects (same object referenced multiple times)
- Circular references (object graphs with cycles)
- Tree structures with parent pointers
**Generated Code:**
| Language | Without `ref` | With `ref` |
| -------- | -------------- | ----------------------------------------- |
| Java | `Node parent` | `Node parent` with `@ForyField(ref=true)` |
| Python | `parent: Node` | `parent: Node = pyfory.field(ref=True)` |
| Go | `Parent Node` | `Parent *Node` with `fory:"ref"` |
| Rust | `parent: Node` | `parent: Arc<Node>` |
| C++ | `Node parent` | `std::shared_ptr<Node> parent` |
#### `repeated`
Marks the field as a list/array:
```protobuf
message Document {
repeated string tags = 1;
repeated User authors = 2;
}
```
**Generated Code:**
| Language | Type |
| -------- | -------------------------- |
| Java | `List<String>` |
| Python | `List[str]` |
| Go | `[]string` |
| Rust | `Vec<String>` |
| C++ | `std::vector<std::string>` |
### Combining Modifiers
Modifiers can be combined:
```protobuf
message Example {
optional repeated string tags = 1; // Nullable list
repeated optional string aliases = 2; // Elements may be null
ref repeated Node nodes = 3; // Collection tracked as a reference
repeated ref Node children = 4; // Elements tracked as references
optional ref User owner = 5; // Nullable tracked reference
}
```
Modifiers before `repeated` apply to the field/collection. Modifiers after
`repeated` apply to elements.
## Type System
### Primitive Types
| Type | Description | Size |
| ----------- | --------------------------- | -------- |
| `bool` | Boolean value | 1 byte |
| `int8` | Signed 8-bit integer | 1 byte |
| `int16` | Signed 16-bit integer | 2 bytes |
| `int32` | Signed 32-bit integer | 4 bytes |
| `int64` | Signed 64-bit integer | 8 bytes |
| `float32` | 32-bit floating point | 4 bytes |
| `float64` | 64-bit floating point | 8 bytes |
| `string` | UTF-8 string | Variable |
| `bytes` | Binary data | Variable |
| `date` | Calendar date | Variable |
| `timestamp` | Date and time with timezone | Variable |
See [Type System](type-system.md) for complete type mappings.
### Named Types
Reference other messages or enums by name:
```protobuf
enum Status { ... }
message User { ... }
message Order {
User customer = 1; // Reference to User message
Status status = 2; // Reference to Status enum
}
```
### Map Types
Maps with typed keys and values:
```protobuf
message Config {
map<string, string> properties = 1;
map<string, int32> counts = 2;
map<int32, User> users = 3;
}
```
**Syntax:** `map<KeyType, ValueType>`
**Restrictions:**
- Key type should be a primitive type (typically `string` or integer types)
- Value type can be any type including messages
## Field Numbers
Each field must have a unique positive integer identifier:
```protobuf
message Example {
string first = 1;
string second = 2;
string third = 3;
}
```
**Rules:**
- Must be unique within a message
- Must be positive integers
- Used for field ordering and identification
- Gaps in numbering are allowed (useful for deprecating fields)
**Best Practices:**
- Use sequential numbers starting from 1
- Reserve number ranges for different categories
- Never reuse numbers for different fields (even after deletion)
## Type IDs
Type IDs enable efficient cross-language serialization:
```protobuf
enum Color [id=100] { ... }
message User [id=101] { ... }
message Order [id=102] { ... }
```
### With Type ID (Recommended)
```protobuf
message User [id=101] { ... }
message User [id=101, deprecated=true] { ... } // Multiple options
```
- Serialized as compact integer
- Fast lookup during deserialization
- Must be globally unique across all types
- Recommended for production use
### Without Type ID
```protobuf
message Config { ... }
```
- Registered using namespace + name
- More flexible for development
- Slightly larger serialized size
- Uses package as namespace: `"package.Config"`
### ID Assignment Strategy
```protobuf
// Enums: 100-199
enum Status [id=100] { ... }
enum Priority [id=101] { ... }
// User domain: 200-299
message User [id=200] { ... }
message UserProfile [id=201] { ... }
// Order domain: 300-399
message Order [id=300] { ... }
message OrderItem [id=301] { ... }
```
## Complete Example
```protobuf
// E-commerce domain model
package com.shop.models;
// Enums with type IDs
enum OrderStatus [id=100] {
PENDING = 0;
CONFIRMED = 1;
SHIPPED = 2;
DELIVERED = 3;
CANCELLED = 4;
}
enum PaymentMethod [id=101] {
CREDIT_CARD = 0;
DEBIT_CARD = 1;
PAYPAL = 2;
BANK_TRANSFER = 3;
}
// Messages with type IDs
message Address [id=200] {
string street = 1;
string city = 2;
string state = 3;
string country = 4;
string postal_code = 5;
}
message Customer [id=201] {
string id = 1;
string name = 2;
optional string email = 3;
optional string phone = 4;
optional Address billing_address = 5;
optional Address shipping_address = 6;
}
message Product [id=202] {
string sku = 1;
string name = 2;
string description = 3;
float64 price = 4;
int32 stock = 5;
repeated string categories = 6;
map<string, string> attributes = 7;
}
message OrderItem [id=203] {
ref Product product = 1; // Track reference to avoid duplication
int32 quantity = 2;
float64 unit_price = 3;
}
message Order [id=204] {
string id = 1;
ref Customer customer = 2;
repeated OrderItem items = 3;
OrderStatus status = 4;
PaymentMethod payment_method = 5;
float64 total = 6;
optional string notes = 7;
timestamp created_at = 8;
optional timestamp shipped_at = 9;
}
// Config without type ID (uses namespace registration)
message ShopConfig {
string store_name = 1;
string currency = 2;
float64 tax_rate = 3;
repeated string supported_countries = 4;
}
```
## Fory Extension Options
FDL supports protobuf-style extension options for Fory-specific configuration. These use the `(fory)` prefix to indicate they are Fory extensions.
### File-Level Fory Options
```protobuf
option (fory).use_record_for_java_message = true;
option (fory).polymorphism = true;
```
| Option | Type | Description |
| ----------------------------- | ---- | ---------------------------------------- |
| `use_record_for_java_message` | bool | Generate Java records instead of classes |
| `polymorphism` | bool | Enable polymorphism for all types |
### Message-Level Fory Options
Options can be specified inside the message body:
```protobuf
message MyMessage {
option (fory).id = 100;
option (fory).evolving = false;
option (fory).use_record_for_java = true;
string name = 1;
}
```
| Option | Type | Description |
| --------------------- | ------ | ----------------------------------------------------------------------------------- |
| `id` | int | Type ID for serialization (sets type_id) |
| `evolving` | bool | Schema evolution support (default: true). When false, schema is fixed like a struct |
| `use_record_for_java` | bool | Generate Java record for this message |
| `deprecated` | bool | Mark this message as deprecated |
| `namespace` | string | Custom namespace for type registration |
**Note:** `option (fory).id = 100` is equivalent to the inline syntax `message MyMessage [id=100]`.
### Enum-Level Fory Options
```protobuf
enum Status {
option (fory).id = 101;
option (fory).deprecated = true;
UNKNOWN = 0;
ACTIVE = 1;
}
```
| Option | Type | Description |
| ------------ | ---- | ---------------------------------------- |
| `id` | int | Type ID for serialization (sets type_id) |
| `deprecated` | bool | Mark this enum as deprecated |
### Field-Level Fory Options
Field options are specified in brackets after the field number:
```protobuf
message Example {
MyType friend = 1 [(fory).ref = true];
string nickname = 2 [(fory).nullable = true];
MyType data = 3 [(fory).ref = true, (fory).nullable = true];
}
```
| Option | Type | Description |
| --------------------- | ---- | --------------------------------------------------------- |
| `ref` | bool | Enable reference tracking (sets ref flag) |
| `nullable` | bool | Mark field as nullable (sets optional flag) |
| `deprecated` | bool | Mark this field as deprecated |
| `thread_safe_pointer` | bool | Rust only: use `Arc` (true) or `Rc` (false) for ref types |
**Note:** `[(fory).ref = true]` is equivalent to using the `ref` modifier: `ref MyType friend = 1;`
Field-level options always apply to the field/collection; use modifiers after
`repeated` to control element behavior.
To use `Rc` instead of `Arc` in Rust for a specific field:
```protobuf
message Graph {
ref Node root = 1 [(fory).thread_safe_pointer = false];
}
```
### Combining Standard and Fory Options
You can combine standard options with Fory extension options:
```protobuf
message User {
option deprecated = true; // Standard option
option (fory).evolving = false; // Fory extension option
string name = 1;
MyType data = 2 [deprecated = true, (fory).ref = true];
}
```
### Fory Options Proto File
For reference, the Fory options are defined in `extension/fory_options.proto`:
```protobuf
// File-level options
extend google.protobuf.FileOptions {
optional ForyFileOptions fory = 50001;
}
message ForyFileOptions {
optional bool use_record_for_java_message = 1;
optional bool polymorphism = 2;
}
// Message-level options
extend google.protobuf.MessageOptions {
optional ForyMessageOptions fory = 50001;
}
message ForyMessageOptions {
optional int32 id = 1;
optional bool evolving = 2;
optional bool use_record_for_java = 3;
optional bool deprecated = 4;
optional string namespace = 5;
}
// Field-level options
extend google.protobuf.FieldOptions {
optional ForyFieldOptions fory = 50001;
}
message ForyFieldOptions {
optional bool ref = 1;
optional bool nullable = 2;
optional bool deprecated = 3;
}
```
## Grammar Summary
```
file := [package_decl] file_option* import_decl* type_def*
package_decl := 'package' package_name ';'
package_name := IDENTIFIER ('.' IDENTIFIER)*
file_option := 'option' option_name '=' option_value ';'
option_name := IDENTIFIER | extension_name
extension_name := '(' IDENTIFIER ')' '.' IDENTIFIER // e.g., (fory).polymorphism
import_decl := 'import' STRING ';'
type_def := enum_def | message_def
enum_def := 'enum' IDENTIFIER [type_options] '{' enum_body '}'
enum_body := (option_stmt | reserved_stmt | enum_value)*
enum_value := IDENTIFIER '=' INTEGER ';'
message_def := 'message' IDENTIFIER [type_options] '{' message_body '}'
message_body := (option_stmt | reserved_stmt | nested_type | field_def)*
nested_type := enum_def | message_def
field_def := [modifiers] field_type IDENTIFIER '=' INTEGER [field_options] ';'
option_stmt := 'option' option_name '=' option_value ';'
option_value := 'true' | 'false' | IDENTIFIER | INTEGER | STRING
reserved_stmt := 'reserved' reserved_items ';'
reserved_items := reserved_item (',' reserved_item)*
reserved_item := INTEGER | INTEGER 'to' INTEGER | INTEGER 'to' 'max' | STRING
modifiers := { 'optional' | 'ref' } ['repeated' { 'optional' | 'ref' }]
field_type := primitive_type | named_type | map_type
primitive_type := 'bool' | 'int8' | 'int16' | 'int32' | 'int64'
| 'float32' | 'float64' | 'string' | 'bytes'
| 'date' | 'timestamp'
named_type := qualified_name
qualified_name := IDENTIFIER ('.' IDENTIFIER)* // e.g., Parent.Child
map_type := 'map' '<' field_type ',' field_type '>'
type_options := '[' type_option (',' type_option)* ']'
type_option := IDENTIFIER '=' option_value // e.g., id=100, deprecated=true
field_options := '[' field_option (',' field_option)* ']'
field_option := option_name '=' option_value // e.g., deprecated=true, (fory).ref=true
STRING := '"' [^"\n]* '"' | "'" [^'\n]* "'"
IDENTIFIER := [a-zA-Z_][a-zA-Z0-9_]*
INTEGER := '-'? [0-9]+
```