Qqwy

Qqwy

TypeCheck Core Team

Is it possible to create typespec for a 'wrapper'?

I am working on creating protocols, behaviours and implementations for multiple kinds of containers. (See Implement Containers for more info)

In many cases, the implementation is separated from the interface. However, it would be really nice if it were possible to write @specs that worked with a collection(/container/wrapper, etc.) containing certain datatypes.

For instance, there is the built-in type list(item). Now, item could be any (which is its default), but if a spec is written containing list(integer) and a non-integer is passed there, then Dialyzer will warn you.

So I’d like to do the same for other types of collection-like data structures. However, as the implementation is hidden from view from the behaviours and protocols, I cannot actually say anything about the internals of these data structures (Other than ‘it should implement this protocol’).

So I’d like to create symbolic wrapper types. Something like:

@type collection(item) :: type

(Using @opaque is probably better here, but that is beside the point.)

Above example will however not compile, as item is a free type variable which is not allowed:

== Compilation error in file lib/insertable.ex ==
** (CompileError) lib/insertable.ex:45: type variable item is only used once (is unbound)
    (stdlib) lists.erl:1338: :lists.foreach/2
    lib/insertable.ex:1: (file)

Is there a way to introduce item on the right hand side here? Or is there another way to create a type for wrapping-structures like queues, sets, trees etc that allows restricting what type of values should be inside?

Most Liked

Qqwy

Qqwy

TypeCheck Core Team

@josevalim responded to me in the IRC channel, stating that Dialyzer cannot handle the dynamic protocol dispatch (at least as it currently stands), that creating specs for this probably wouldn’t really work.

So… I guess it is impossible, at least right now.

Where Next?

Popular in Questions Top

JDanielMartinez
Hi! May someone helps me, please! I have two apps into an umbrella project: the first one is Database, which manages queries, and the se...
New
joaquinalcerro
Hi there, I am working with Ecto-Postgresql and I need to call all of the records from a specific table but the table has 40,000 record...
New
aalberti333
As the title describes, I’m trying to run Enum.map() over a list of key/value pairs, where the value is a map. My data looks like this: ...
New
lastday4you
I wanted to check elixir version in phoenix because i found that my elixir is 1.5 but when i use Enum.chunk_by it said the function is un...
New
stefanchrobot
What’s the safe way to decode a JSON string into a struct? I want to avoid calling String.to_atom. Jason.decode can give me a map with st...
New
freewebwithme
Using vs code and installed ElixirLS: support and debugger. And I got an error popped up on start up says Failed to run ‘elixir’ comma...
New
shahryarjb
Hello, I have map which I want to convert it to string like this: the map: %{last_name: "tavakkoli", name: "shahryar"} the string I ne...
New
johnnyicon
Hi all, I've just started learning Elixir and Phoenix Framework, so please pardon my n00bness at this stage. I'm trying to use Postg...
New
kostonstyle
Hi all I want to have a unix time, from the current time plus 1 hour. DateTime.now + 1 hour How to get it in elixir? Thanks
New
vrod
I am using the Starship cross-shell prompt – it seems pretty nice, but I get some errors: [WARN] - (starship::utils): Executing command ...
New

Other popular topics Top

srinivasu
How to handle excepions in elixir? Suppose i have A, B, C ,D, E modules. and each module has get() function. A.get() method will call th...
New
dotdotdotPaul
Okay, I'm having a heck of a time trying to figure out how to best handle the validation of belongs_to associations in Ecto. I'm sure I'...
New
bsollish-terakeet
Credo is smart enough to check for (something like) this: assert length(the_list) == 0 with this response: Checking if an enum is empt...
New
yawaramin
In the Dialyzer docs ( http://erlang.org/doc/man/dialyzer.html#requesting-or-suppressing-warnings-in-source-files ), there is a way to tu...
New
aalberti333
As the title describes, I’m trying to run Enum.map() over a list of key/value pairs, where the value is a map. My data looks like this: ...
New
vac
Hi, I'm quite new in Elixir and I'm trying to format a string to a PEM format. I have the certificate value like MIIDBTCCAe2...... and ...
New
minhajuddin
I have seen a lot of code which picks the first element from a list using Enum.at(0) instead of List.first. Is there a reason why people ...
New
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New
electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
Fl4m3Ph03n1x
About me? ( if you have nothing better to do than reading about some random guy in the internet :stuck_out_tongue: ) Hello all, this is ...
New

We're in Beta

About us Mission Statement