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

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
kpanic
Hi everyone, I am toying with the idea of building a “match maker” for giving personal help to people that wants to start coding. I sta...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
asweet-confluent
I recently noticed that Elixir’s Logger defaults its primary log level to :debug when no :logger, :level application configuration is pre...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New

Latest on Elixir Forum

Elixir Forum

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews