Structs en

Acerca de Structs

Los structs son mapas especiales con un conjunto definido de claves.

• Los structs ofrecen verificaciones en tiempo de compilación y valores por defecto.
• Un struct lleva el nombre del módulo en el que se define.
• Para definir un struct, usa la construcción defstruct.
  • Por lo general, esta construcción va justo después de la definición del módulo.
• defstruct acepta una lista de átomos (para valores por defecto de nil) o listas de palabras clave (para valores por defecto específicos).
  • Los campos sin valores por defecto deben ir antes que los campos con valores por defecto.

defmodule Plane do
  defstruct [:engine, wings: 2]
end

plane = %Plane{}
# => %Plane{engine: nil, wings: 2}

Acceder a los campos y actualizarlos

• La mayoría de las funciones que trabajan con mapas también funcionan con structs.

  • El comportamiento Access es una excepción y no está implementado para los structs.

• Se recomienda usar el operador de acceso estático . para acceder a los campos de un struct.

• Obtener o recuperar los valores de los campos:

  plane = %Plane{}
  plane.engine
  # => nil
  Map.fetch(plane, :wings)
  # => {:ok, 2}
  

• Actualizar los valores de los campos

  plane = %Plane{}
  %{plane | wings: 4}
  # => %Plane{engine: nil, wings: 4}
  

Forzar la inicialización de los valores de los campos

• El atributo de módulo @enforce_keys crea una verificación en tiempo de ejecución de que ciertos campos deben inicializarse con un valor que no sea nil cuando se crea el struct.
• A @enforce_keys le sigue una lista de las claves de los campos (que son átomos).
• Si una clave obligatoria no se inicializa, se produce un error.

defmodule User do
  @enforce_keys [:username]
  defstruct [:username]
end

%User{}
# => (ArgumentError) the following keys must also be given when building struct User: [:username]