-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Update structs.md #14683
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
Merged
Merged
Update structs.md #14683
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,6 @@ | |
SPDX-License-Identifier: Apache-2.0 | ||
SPDX-FileCopyrightText: 2021 The Elixir Team | ||
--> | ||
|
||
# Structs | ||
|
||
We learned about maps [in earlier chapters](keywords-and-maps.md): | ||
|
@@ -20,7 +19,7 @@ Structs are extensions built on top of maps that provide compile-time checks and | |
|
||
## Defining structs | ||
|
||
To define a struct, the `defstruct/1` construct is used: | ||
To define a struct, the [`defstruct/1`](https://hexdocs.pm/elixir/Kernel.html#defstruct/1) construct is used: | ||
|
||
```elixir | ||
iex> defmodule User do | ||
|
@@ -30,7 +29,9 @@ iex> defmodule User do | |
|
||
The keyword list used with `defstruct` defines what fields the struct will have along with their default values. Structs take the name of the module they're defined in. In the example above, we defined a struct named `User`. | ||
|
||
We can now create `User` structs by using a syntax similar to the one used to create maps: | ||
## Creating structs | ||
|
||
We can create `User` structs by using a syntax similar to the one used to create maps: | ||
|
||
```elixir | ||
iex> %User{} | ||
|
@@ -46,26 +47,129 @@ iex> %User{oops: :field} | |
** (KeyError) key :oops not found expanding struct: User.__struct__/1 | ||
``` | ||
|
||
## Accessing and updating structs | ||
You can also create structs using `Kernel.struct/2`: | ||
|
||
```elixir | ||
iex> struct(User) | ||
%User{age: 27, name: "John"} | ||
iex> struct(User, name: "Jane") | ||
%User{age: 27, name: "Jane"} | ||
iex> struct(User, %{name: "Jane", age: 30}) | ||
%User{age: 30, name: "Jane"} | ||
``` | ||
|
||
### Default values and required keys | ||
|
||
If you don't specify a default key value when defining a struct, `nil` will be assumed: | ||
|
||
```elixir | ||
iex> defmodule Product do | ||
...> defstruct [:name] | ||
...> end | ||
iex> %Product{} | ||
%Product{name: nil} | ||
``` | ||
|
||
You can define a structure combining both fields with explicit default values, and implicit `nil` values. In this case you must first specify the fields which implicitly default to nil: | ||
|
||
```elixir | ||
iex> defmodule User do | ||
...> defstruct [:email, name: "John", age: 27] | ||
...> end | ||
iex> %User{} | ||
%User{age: 27, email: nil, name: "John"} | ||
``` | ||
|
||
Doing it in reverse order will raise a syntax error: | ||
|
||
```elixir | ||
iex> defmodule User do | ||
...> defstruct [name: "John", age: 27, :email] | ||
...> end | ||
** (SyntaxError) iex:107: unexpected expression after keyword list. Keyword lists must always come last in lists and maps. | ||
``` | ||
|
||
You can also enforce that certain keys have to be specified when creating the struct via the `@enforce_keys` module attribute: | ||
|
||
```elixir | ||
iex> defmodule Car do | ||
...> @enforce_keys [:make] | ||
...> defstruct [:model, :make] | ||
...> end | ||
iex> %Car{} | ||
** (ArgumentError) the following keys must also be given when building struct Car: [:make] | ||
expanding struct: Car.__struct__/1 | ||
``` | ||
|
||
Enforcing keys provides a simple compile-time guarantee to aid developers when building structs. It is not enforced on updates and it does not provide any sort of value-validation. | ||
|
||
## Accessing struct fields | ||
|
||
Structs share the same syntax for accessing and updating fields as maps of fixed keys: | ||
Structs support dot notation for accessing fields: | ||
|
||
```elixir | ||
iex> john = %User{} | ||
%User{age: 27, name: "John"} | ||
iex> john.name | ||
"John" | ||
iex> john.age | ||
27 | ||
``` | ||
|
||
Unlike maps, structs do not support bracket notation access: | ||
|
||
```elixir | ||
iex> john[:name] | ||
** (UndefinedFunctionError) function User.fetch/2 is undefined (User does not implement the Access behaviour) | ||
User.fetch(%User{age: 27, name: "John"}, :name) | ||
``` | ||
|
||
## Updating fields | ||
|
||
When you need to update specific fields with known values, use the update syntax: | ||
|
||
```elixir | ||
iex> john = %User{name: "John", age: 27} | ||
%User{age: 27, name: "John"} | ||
iex> jane = %{john | name: "Jane"} | ||
%User{age: 27, name: "Jane"} | ||
iex> older_jane = %{jane | age: 30, name: "Jane Smith"} | ||
%User{age: 30, name: "Jane Smith"} | ||
``` | ||
|
||
The update syntax ensures that only existing struct fields can be updated: | ||
|
||
```elixir | ||
iex> %{jane | oops: :field} | ||
** (KeyError) key :oops not found in: %User{age: 27, name: "Jane"} | ||
``` | ||
|
||
When using the update syntax (`|`), Elixir is aware that no new keys will be added to the struct, allowing the maps underneath to share their structure in memory. In the example above, both `john` and `jane` share the same key structure in memory. | ||
|
||
Structs can also be used in pattern matching, both for matching on the value of specific keys as well as for ensuring that the matching value is a struct of the same type as the matched value. | ||
## Merging data | ||
|
||
When you have data in maps or keyword lists that you want to merge into a struct, use `Kernel.struct/2`. It accepts maps, keyword lists, or any enumerable that emits key-value pairs, and automatically discards keys that are not defined in the struct: | ||
|
||
```elixir | ||
iex> john = %User{name: "John", age: 27} | ||
%User{age: 27, name: "John"} | ||
iex> fields = [name: "Jane", age: 30] | ||
[name: "Jane", age: 30] | ||
iex> struct(john, fields) | ||
%User{age: 30, name: "Jane"} | ||
iex> struct(john, %{name: "Jane", invalid_key: "ignored"}) | ||
%User{age: 27, name: "Jane"} | ||
iex> struct(john, [name: "Jane", another_invalid: "also ignored"]) | ||
%User{age: 27, name: "Jane"} | ||
``` | ||
|
||
## Pattern matching structs | ||
|
||
Pattern matching structs is one of the most powerful features in Elixir. You can match on struct types, extract specific fields, and ensure data integrity all in one expression: | ||
|
||
```elixir | ||
iex> john = %User{name: "John", age: 27} | ||
%User{age: 27, name: "John"} | ||
iex> %User{name: name} = john | ||
%User{age: 27, name: "John"} | ||
iex> name | ||
|
@@ -74,13 +178,57 @@ iex> %User{} = %{} | |
** (MatchError) no match of right hand side value: %{} | ||
``` | ||
|
||
For more details on creating, updating, and pattern matching structs, see the documentation for `%/2`. | ||
Pattern matching structs is particularly useful in function heads to handle different data types: | ||
|
||
```elixir | ||
defmodule Notification do | ||
def send(%ChatMessage{user: user, text: text}) do | ||
"#{user}: #{text}" | ||
end | ||
|
||
def send(%FriendRequest{sender: sender}) do | ||
"#{sender} wants to be your friend" | ||
end | ||
|
||
def send(%GameInvite{sender: sender, game: game}) do | ||
"#{sender} invited you to play #{game}" | ||
end | ||
end | ||
``` | ||
|
||
For more details on creating, updating, and pattern matching structs, see the documentation for [`Kernel.SpecialForms.%/2`](https://hexdocs.pm/elixir/Kernel.SpecialForms.html#%25/2). | ||
|
||
## Broken structs | ||
|
||
Since structs are maps underneath, it's possible to change them using `Map` functions. However, this can "break" the struct by adding fields that were not defined in `defstruct`, turning it into a plain map: | ||
|
||
## Structs are bare maps underneath | ||
```elixir | ||
iex> john = %User{name: "John", age: 27} | ||
%User{age: 27, name: "John"} | ||
iex> broken = Map.put(john, :email, "[email protected]") | ||
%{__struct__: User, age: 27, email: "[email protected]", name: "John"} | ||
iex> is_map(broken) | ||
true | ||
``` | ||
|
||
The result may look like a struct but it's actually a plain map with extra fields. This can lead to unexpected behavior when pattern matching or using protocols. | ||
|
||
To safely merge data into structs, always use `Kernel.struct/2` instead of `Map` functions: | ||
|
||
```elixir | ||
iex> john = %User{name: "John", age: 27} | ||
%User{age: 27, name: "John"} | ||
iex> struct(john, %{name: "Jane", email: "ignored"}) | ||
%User{age: 27, name: "Jane"} | ||
``` | ||
|
||
## Structs vs maps | ||
|
||
Structs are simply maps with a "special" field named `__struct__` that holds the name of the struct: | ||
|
||
```elixir | ||
iex> john = %User{name: "John", age: 27} | ||
%User{age: 27, name: "John"} | ||
iex> is_map(john) | ||
true | ||
iex> john.__struct__ | ||
|
@@ -100,48 +248,3 @@ iex> Enum.each(john, fn {field, value} -> IO.puts(value) end) | |
``` | ||
|
||
Structs alongside protocols provide one of the most important features for Elixir developers: data polymorphism. That's what we will explore in the next chapter. | ||
|
||
## Default values and required keys | ||
|
||
If you don't specify a default key value when defining a struct, `nil` will be assumed: | ||
|
||
```elixir | ||
iex> defmodule Product do | ||
...> defstruct [:name] | ||
...> end | ||
iex> %Product{} | ||
%Product{name: nil} | ||
``` | ||
|
||
You can define a structure combining both fields with explicit default values, and implicit `nil` values. In this case you must first specify the fields which implicitly default to `nil`: | ||
|
||
```elixir | ||
iex> defmodule User do | ||
...> defstruct [:email, name: "John", age: 27] | ||
...> end | ||
iex> %User{} | ||
%User{age: 27, email: nil, name: "John"} | ||
``` | ||
|
||
Doing it in reverse order will raise a syntax error: | ||
|
||
```elixir | ||
iex> defmodule User do | ||
...> defstruct [name: "John", age: 27, :email] | ||
...> end | ||
** (SyntaxError) iex:107: unexpected expression after keyword list. Keyword lists must always come last in lists and maps. | ||
``` | ||
|
||
You can also enforce that certain keys have to be specified when creating the struct via the `@enforce_keys` module attribute: | ||
|
||
```elixir | ||
iex> defmodule Car do | ||
...> @enforce_keys [:make] | ||
...> defstruct [:model, :make] | ||
...> end | ||
iex> %Car{} | ||
** (ArgumentError) the following keys must also be given when building struct Car: [:make] | ||
expanding struct: Car.__struct__/1 | ||
``` | ||
|
||
Enforcing keys provides a simple compile-time guarantee to aid developers when building structs. It is not enforced on updates and it does not provide any sort of value-validation. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say that this is bug in ExDoc if it is not autodiscovered. But IMHO that should not use absolute link to HexDocs. I think that there is some other way to cross-link, but someone more familiar with ExDoc need to point that out.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do autolink and it works currently as is: https://hexdocs.pm/elixir/structs.html