-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Update "Structs with 32 fields or more" anti pattern #13942
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -559,7 +559,7 @@ | |
|
|
||
| The Erlang VM has two internal representations for maps: a flat map and a hash map. A flat map is represented internally as two tuples: one tuple containing the keys and another tuple holding the values. Whenever you update a flat map, the tuple keys are shared, reducing the amount of memory used by the update. A hash map has a more complex structure, which is efficient for a large amount of keys, but it does not share the key space. | ||
|
|
||
| Maps of up to 32 keys are represented as flat maps. All others are hash map. Since structs maintain a metadata key called `__struct__`, any struct with fewer than 32 fields are represented as a flat map, which allows us to optimize several struct operations, as we never add or remove fields to structs, we simply update them. | ||
| Maps of up to 32 keys are represented as flat maps. All others are hash map. Structs _are_ maps (with a metadata field called `__struct__`) and so any struct with fewer than 32 fields is represented as a flat map. This allows us to optimize several struct operations, as we never add or remove fields to structs, we simply update them. | ||
|
Check failure on line 562 in lib/elixir/pages/anti-patterns/code-anti-patterns.md
|
||
|
|
||
| Furthermore, structs of the same name "instantiated" in the same module will share the same "tuple keys" at compilation times, as long as they have fewer than 32 fields. For example, the following code: | ||
|
|
||
|
|
@@ -577,10 +577,10 @@ | |
|
|
||
| Removing this anti-pattern, in a nutshell, requires ensuring your struct has fewer than 32 fields. There are a few techniques you could apply: | ||
|
|
||
| * If the struct has "optional" fields, for example, fields which are initialized with nil, you could nest all optional fields into other field, called `:metadata`, `:optionals`, or similar. This could lead to benefits such as being able to use pattern matching to check if a field exists or not, instead of relying on `nil` values | ||
|
Check failure on line 580 in lib/elixir/pages/anti-patterns/code-anti-patterns.md
|
||
|
|
||
| * You could nest structs, by storing structs within other fields. Fields that are rarely read or written to are good candidates to be moved to a nested struct | ||
|
Check failure on line 582 in lib/elixir/pages/anti-patterns/code-anti-patterns.md
|
||
|
|
||
| * You could nest fields as tuples. For example, if two fields are always read or updated together, they could be moved to a tuple (or another composite data structure) | ||
|
Check failure on line 584 in lib/elixir/pages/anti-patterns/code-anti-patterns.md
|
||
|
|
||
| The challenge is to balance the changes above with API ergonomics, in particular, when fields may be frequentlyb read and written to. | ||
Uh oh!
There was an error while loading. Please reload this page.