@sfusato’s response is very good, though it seems that in some instances you’d want to expressly name the excluded struct parameters, rather than list all of the unexcluded ones.
The Inspect protocol actually allows you to name the struct attributes that are excluded from inspection, which is cleaner for circumstances in which most of a struct’s attributes are not private or secret. Here’s an example:
defmodule CustomRequest do
@derive {Inspect, except: [:password]}
defstruct [:name, :email, :password]
end
If you had a myriad of secret attributes within a single struct though, using only is probably cleaner and safer, as adding additional secret attributes would not require you to also add them for exclusion:
defmodule CustomRequest do
@derive {Inspect, only: [:name, :email]}
defstruct [
:name,
:email,
:password,
:secret_token,
:secret_id
]
end
Please note that the @derive call does have to be declared above the defstruct keyword as indicated in the Inspect docs, as shown above.
