Skip to content
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

Add info about structs in the encode docs #19

Open
williamthome opened this issue Aug 9, 2024 · 0 comments
Open

Add info about structs in the encode docs #19

williamthome opened this issue Aug 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@williamthome
Copy link
Owner

The encode documentation misses that structs are handled by the encode_map function as:

  defp encode_map(struct, state) when is_map_key(struct, :__struct__) do
    :euneus_encoder.encode_map(Map.from_struct(struct), state)
  end

  defp encode_map(map, state) do
    :euneus_encoder.encode_map(map, state)
  end

i.e., structs are encoded as Map.from_struct(struct).

@williamthome williamthome added the documentation Improvements or additions to documentation label Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant