vrod

vrod

I’m pretty new to Elixir. One thing I don’t think I understand is the typespecs, specifically when they deal with structs. A common pattern I’ve seen is that the struct definition is frequently accompanied by a @type t definition, something like this:

defmodule MyStruct do
  
  defstruct x: "",
            y: false,
            z: 0
            
  @type t :: %__MODULE__{
               x: String.t(),
               y: boolean,
               z: integer
             }
end

A struct is defined AND a @type t. If I want to use this struct in function @spec, I have seen both the struct or this type t referenced, e.g.

@spec my_func(%MyStruct{}) :: any

or

@spec my_func(MyStruct.t()) :: any

apply to a function, e.g.

def my_func(%MyStruct{} = input) do
    # something...
end

So my questions are:

  1. Is the @type t special? Or is that just a convention?
  2. Is there any difference between using %MyStruct{} or MyStruct.t() in function specs?
  3. Is there any case where you would use one and not the other?
  4. Is the @type t more “specific” because it can declare the types of various keys in the struct? (Whereas the struct itself only defines the names of the keys, not their data types)

Thanks for any clarifications. I’m sure I missed something in my studies thus far.

Showing Posts 1 to 4

harmon25

harmon25

To answer your question, t() is not special, it is just convention.
One thing to remember is that a struct is just a fancy map.

You can create a type with a map that specifies keys and their types just the same:

  @type special_map :: %{some_key: String.t()}
hauleth

hauleth

Convention.

Yes. If you will use just %MyStruct{} then the types specified in t() will not be used. So:

@type t :: %MyStruct{a: integer()}

@spec pass(%MyStruct{}) :: term()
def pass(t), do: t

@spec fail(t()) :: term()
def fail(t), do: t

s = %MyStruct{a: "bar"}

pass(s)
fail(s) # this will cause Dialyzer error

If there is defined t() then you should always use that.

Yes, as shown above.

17
Post #2
vrod

vrod OP

Thanks! That makes sense.

bartblast

bartblast

Creator of Hologram

Another issue worth mentioning is that using %MyModule{} in typespec will create a compile-time dependency, so every time MyModule is changed, the modules that use %MyModule{} in typespecs will need to be recompiled.

— All posts loaded —

Where Next? Top

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
Blokh
Hey guys, I’ve got a huge CSV ( around 10 GB ) that needs to be processed hourly Do you guys have any suggestions what is the best prac...
New
kszambelanczyk
Hello! Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app. I creat...
New
Onor.io
I have what I’ve heard referred to as a “lookup table” in my database. This is a way of assigning codes to common values. One common lo...
New
jaybe78
Hello, I’m developing a online persistent chat system (what’s app) like using elixir/dynamodb/aws for a mobile app(flutter). The diffic...
New
Trolleger
What approach to take when sending live updates to “random” users Hi! I have a question, I have a little chat app, and when I create a DM...
New
widianto
I think I’ve found a small improvement I could contribute to <%= web_namespace %>.CoreComponents (installer/templates/phx_web/compo...
New

Other Trending Topics Top

garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
wintermeyer
There are three potential reasons for members of this forum to have a look at https://vutuv.de You are tired or annoyed of LinkedIn. Yo...
New
aseigo
ICal is a library for interacting with iCalendar data. It parses iCalendars into typed Elixir structs via ICal.from_ics, and can prepare ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews