kalkatfyodor

kalkatfyodor

I am watching this video https://youtu.be/_rTFZbvMfJA?t=1252 and the presenter is saying that putting @impl true offers some better error handling - but doesn’t go deeper. In other tutorials like this one https://youtu.be/x1rx4-AAcMQ?t=346 where they don’t put @impl true before mount, render and handle functions.

Should I put @impl true before each function in Phoenix or not?

Showing Posts 1 to 10

tomkonidas

tomkonidas

That is because he is implementing a Behaviour.

No, you do not need it for every function. But if you put on one function in the module,
then it will complain to put on the others.

kalkatfyodor

kalkatfyodor OP

I have no idea what you are talking about but thank you anyway.

gabriel137

gabriel137

This feature informs the terminal which functions are returned from a call like in GenServer. You don’t need to include them at all, just the first one.

To learn more, view the link below, I recommend that you first understand what GenServers are.

https://elixircasts.io/%40impl-attribute

tomkonidas

tomkonidas

So you can define a behaviour and implement it. For example, lets use payment provider.

If we know we will have multiple payment providers (ex: Stripe, Paypal, etc…), we might want a behaviour for payment providers. We can do this with a behaviour.
We can define the behaviour and say that every module that implements the MyApp.PaymentProvider behaviour needs to implement a credit/2 and debit/2 for example.

Now in our own Stripe module we can @behaviour MyApp.PaymentProvider and that is saying that we will need to implement the 2 callbacks we defined:

  • debit/2
  • credit/2

Now we have a way to make sure we are able to switch between Paypal and Stripe because they follow the same contract. Both Paypal.credit/2 and Stripe.credit/2 should take the same args and return the same type/structure.

With Phoenix, they have optional callbacks, You can define your own or use the default. That is why you do not need to implement Phoenix.LiveComponent.update/2, but you can impl it if you want.

In your module, if you put one @impl over a function, I believe the compiler will complain. Because you iplemented it for another callback but not that specific one, so it thinks you made a possible mistake.

11
Post #4
eksperimental

eksperimental

It is good practice.
Even better, to use the name of the behaviour module that you are implementing, instead of just true. This is necessary when a module implement more than one behaviour.

It will definitely improve the readability and maintainability of your code.

Read more about @impl and behaviours in:

eksperimental

eksperimental

You need to understand the concept of behaviours first in order to understand what @impl is for.

kalkatfyodor

kalkatfyodor OP

his module is deprecated. Use @callback and @macrocallback attributes instead.

kalkatfyodor

kalkatfyodor OP

So, behaviour is deprecated?

LostKobrakai

LostKobrakai

The functionality of behaviours is still existing, though the old api is deperectated in favor of the newer one.

kalkatfyodor

kalkatfyodor OP

Can you give a real world example about this behavior? Have you ever used it? How? And what problem did it solve? I can’t wrap my head around it. I have never needed something like that.

Where Next? Top

Trending in Questions Top

itzmidinesh
Hi all, I’m working on a Phoenix project where I need to make external HTTP requests and I’m trying to choose between Req and HTTPoison....
New
yarrichar
I’m very new to Elixir, so sorry if this is a silly question: I am wondering what happens to the mailbox of a process when the machine i...
New
pragdave
How do I tell Hologram not to escape HTML when substituting into templates? {Textile.render(@product.long_description)} escapes the HTM...
New
Fl4m3Ph03n1x
Background When trying to execute mix release on a Windows 11 machine for a Phoenix project I get the following error: * assembling mark...
New
rlipscombe
I’d like to create a file with 600 permissions (rw-------), but there’s a race condition if I create it and then change the permissions. ...
New
saleyn
Is there a way to import record definitions in the iex shell for pretty printing (similar to the rr command in the erl shell)? This woul...
New
rlipscombe
When I use Mix.install with a git dependency, using git@github.com:... how do I change the SSH identity used? I’ve got two Github accoun...
New

Other Trending Topics Top

dominicletz
Hey there, I haven’t seen a list of useful Elixir specific skills for the popular AI tools yet so I’m starting one here with my first. ...
New
raa-ziq
Hi everyone :waving_hand: I wanted to share something I’ve been building — NowBlind, a random chat app designed to help people discover ...
New
mudasobwa
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
KristerV
Hey. Is there anyone here who creates agents in their apps? Not talking about using agents, but creating them. I’m finding it pretty diff...
New
OndrejValenta
(I just needed to vent somewhere and LinkedIn is full of hope, or hype, I’m not sure which exactly) AI dream has many faces, but general...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews