Skip to content

Document get_meta/2 a bit more #4658

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.

Sign up for GitHub

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 2 commits into from
Sep 15, 2025
Merged

Document get_meta/2 a bit more #4658

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3567c7
Document get_meta/2 a bit more
nathanl Sep 15, 2025
c0e80f3
Update lib/ecto.ex
josevalim Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion lib/ecto.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,13 @@ defmodule Ecto do

@doc """
Gets the metadata from the given struct.

For example, to check whether it has been persisted:

iex> Ecto.get_meta(changeset.data, :state)
:built

See `Ecto.Schema.Metadata`.
"""
def get_meta(struct, :context),
do: struct.__meta__.context
Expand All @@ -625,7 +632,7 @@ defmodule Ecto do
* `:context` - changes the struct meta context
* `:state` - changes the struct state

Please refer to the `Ecto.Schema.Metadata` module for more information.
See `Ecto.Schema.Metadata`.
"""
@spec put_meta(Ecto.Schema.schema(), meta) :: Ecto.Schema.schema()
when meta: [
Expand Down
Loading