Исходный код Шаблоны и гварды

Elixir предоставляет сопоставление с шаблонами, которое позволяет нам утверждать о форме или извлекать значения из структур данных. Шаблоны часто дополняются гвардами, которые предоставляют разработчикам возможность выполнять более сложные проверки, хотя и ограниченные.

Этот документ содержит полную справку по шаблонам и гвардам, их семантике, где они разрешены и как их расширить.

Шаблоны

Шаблоны в Elixir состоят из переменных, литералов и специфичной для структуры данных синтаксики. Одним из наиболее часто используемых конструктов для выполнения сопоставления с шаблоном является оператор соответствия (=):

iex> x = 1
1
iex> 1 = x
1

В примере выше, x начинается без значения и получает значение 1. Затем мы сравниваем значение x с литералом 1, что успешно, так как они оба являются 1.

Сопоставление x с 2 вызовет:

iex> 2 = x
** (MatchError) no match of right hand side value: 1

Шаблоны не двунаправленные. Если у вас есть переменная y, которой никогда не присваивалось значение (часто называется несвязанной переменной), и вы напишете 1 = y, будет выброшено сообщение об ошибке:

iex> 1 = y
** (CompileError) iex:2: undefined variable "y"

Другими словами, шаблоны разрешены только в левой части =. Правая часть = следует стандартной семантике вычисления языка.

Теперь давайте рассмотрим правила сопоставления с шаблонами для каждого конструкта, а затем для каждого соответствующего типа данных.

Переменные

Переменные в шаблонах всегда присваиваются:

iex> x = 1
1
iex> x = 2
2
iex> x
2

Другими словами, Elixir поддерживает повторную привязку. В случае, если вы не хотите, чтобы значение переменной менялось, вы можете использовать оператор привязки (^):

iex> x = 1
1
iex> ^x = 2
** (MatchError) no match of right hand side value: 2

Если одна и та же переменная встречается несколько раз в одном шаблоне, то все они должны быть связаны с одним и тем же значением:

iex> {x, x} = {1, 1}
{1, 1}
iex> {x, x} = {1, 2}
** (MatchError) no match of right hand side value: {1, 2}

Переменная с подчеркиванием (_) имеет специальное значение, так как она никогда не может быть связана ни с каким значением. Она особенно полезна, когда вам не нужно какое-то определённое значение в шаблоне:

iex> {_, integer} = {:not_important, 1}
{:not_important, 1}
iex> integer
1
iex> _
** (CompileError) iex:3: invalid use of _

Литералы (числа и атомы)

Атомы и числа (целые и вещественные) могут встречаться в шаблонах и всегда представляются как есть. Например, атом будет соответствовать только атому, если они являются одним и тем же атомом:

iex> :atom = :atom
:atom
iex> :atom = :another_atom
** (MatchError) no match of right hand side value: :another_atom

Аналогичное правило относится к числам. Наконец, обратите внимание, что числа в шаблонах выполняют строгое сравнение. Другими словами, целые числа не соответствуют вещественным числам:

iex> 1 = 1.0
** (MatchError) no match of right hand side value: 1.0

Кортежи

Кортежи могут встречаться в шаблонах, используя синтаксис фигурных скобок ({}). Кортеж в шаблоне будет соответствовать только кортежам того же размера, где каждый отдельный элемент кортежа также должен соответствовать:

iex> {:ok, integer} = {:ok, 13}
{:ok, 13}

# won't match due to different size
iex> {:ok, integer} = {:ok, 11, 13}
** (MatchError) no match of right hand side value: {:ok, 11, 13}

# won't match due to mismatch on first element
iex> {:ok, binary} = {:error, :enoent}
** (MatchError) no match of right hand side value: {:error, :enoent}

Списки

Списки могут встречаться в шаблонах, используя синтаксис квадратных скобок ([]). Список в шаблоне будет соответствовать только спискам того же размера, где каждый отдельный элемент списка также должен соответствовать:

iex> [:ok, integer] = [:ok, 13]
[:ok, 13]

# won't match due to different size
iex> [:ok, integer] = [:ok, 11, 13]
** (MatchError) no match of right hand side value: [:ok, 11, 13]

# won't match due to mismatch on first element
iex> [:ok, binary] = [:error, :enoent]
** (MatchError) no match of right hand side value: [:error, :enoent]

В отличие от кортежей, списки также позволяют сопоставление с непустыми списками, используя обозначение [head | tail], которое соответствует head и tail списка:

iex> [head | tail] = [1, 2, 3]
[1, 2, 3]
iex> head
1
iex> tail
[2, 3]

Несколько элементов могут предшествовать конструкту | tail:

iex> [first, second | tail] = [1, 2, 3]
[1, 2, 3]
iex> tail
[3]

Обратите внимание, что [head | tail] не соответствует пустым спискам:

iex> [head | tail] = []
** (MatchError) no match of right hand side value: []

Поскольку списки символов представляются как список целых чисел, можно также выполнять сопоставление префиксов со списками символов, используя оператор конкатенации списков (++):

iex> ~c"hello " ++ world = ~c"hello world"
~c"hello world"
iex> world
~c"world"

Что эквивалентно сопоставлению с [?h, ?e, ?l, ?l, ?o, ?\s | world]. Сопоставления суффиксов (hello ++ ~c" world") не являются допустимыми шаблонами.

Карты

Карты могут встречаться в шаблонах с использованием символа процента, за которым следуют фигурные скобки (%{}). В отличие от списков и кортежей, карты выполняют частичное соответствие. Это означает, что шаблон карты будет соответствовать любой другой карте, которая имеет как минимум все ключи в шаблоне.

Вот пример, где все ключи соответствуют:

iex> %{name: name} = %{name: "meg"}
%{name: "meg"}
iex> name
"meg"

Вот пример, где соответствует подмножество ключей:

iex> %{name: name} = %{name: "meg", age: 23}
%{age: 23, name: "meg"}
iex> name
"meg"

Если ключ в шаблоне недоступен в карте, то они не будут соответствовать:

iex> %{name: name, age: age} = %{name: "meg"}
** (MatchError) no match of right hand side value: %{name: "meg"}

Обратите внимание, что пустая карта соответствует всем картам, что является противоположностью кортежам и спискам, где пустой кортеж или пустой список соответствуют только пустым кортежам и пустым спискам соответственно:

iex> %{} = %{name: "meg"}
%{name: "meg"}

Наконец, обратите внимание, что ключи карт в шаблонах всегда должны быть литералами или ранее связанными переменными, сопоставленными с оператором привязки.

Структуры

Структуры могут встречаться в шаблонах с использованием символа процента, имени модуля структуры или переменной, за которым следует синтаксис фигурных скобок (%{}).

Учитывая следующую структуру:

defmodule User do
  defstruct [:name]
end

Вот пример, где все ключи соответствуют:

iex> %User{name: name} = %User{name: "meg"}
%User{name: "meg"}
iex> name
"meg"

Если задан неизвестный ключ, компилятор выведет ошибку:

iex> %User{type: type} = %User{name: "meg"}
** (CompileError) iex: unknown key :type for struct User

Имя структуры можно извлечь, используя переменную вместо имени модуля:

iex> %struct_name{} = %User{name: "meg"}
%User{name: "meg"}
iex> struct_name
User

Бинарные данные

Бинарные данные могут встречаться в шаблонах с использованием синтаксиса двойного меньше-больше (<<>>). Бинарные данные в шаблоне могут соответствовать нескольким сегментам одновременно, каждый из которых имеет разный тип, размер и единицу:

iex> <<val::unit(8)-size(2)-integer>> = <<123, 56>>
"{8"
iex> val
31544

См. документацию по <<>> для полного определения сопоставления с шаблоном для бинарных данных.

Наконец, помните, что строки в Elixir — это бинарные данные в кодировке UTF-8. Это означает, что, аналогично спискам символов, сопоставления префиксов со строками также возможны с помощью оператора конкатенации бинарных данных (<>):

iex> "hello " <> world = "hello world"
"hello world"
iex> world
"world"

Сопоставления суффиксов (hello <> " world") не являются допустимыми шаблонами.

Гварды

Гварды — это способ дополнить сопоставление с шаблонами более сложными проверками. Они разрешены в определённом наборе конструктов, где разрешено сопоставление с шаблонами, таких как определения функций, разделы case и другие.

Не все выражения разрешены в разделах гвардов, а только ограниченное число. Это осознанное решение. Таким образом, Elixir (через Erlang) гарантирует, что все гварды предсказуемы (без мутаций или других побочных эффектов) и могут быть оптимизированы и выполняться эффективно.

Список разрешённых функций и операторов

Вы можете найти встроенный список гвардов в модуле Kernel. Вот обзор:

операторы сравнения (==, !=, ===, !==, <, <=, >, >=)
строго булевы операторы (and, or, not). Обратите внимание, что операторы &&, || и ! не разрешены, так как они не являются строго булевыми — это означает, что они не требуют, чтобы аргументы были булевыми
арифметические унарные операторы (+, -)
арифметические бинарные операторы (+, -, *, /)
операторы in и not in (при условии, что правая часть — список или диапазон)
функции «проверки типа» (is_list/1, is_number/1 и т. п.)
функции, работающие со встроенными типами данных (abs/1, hd/1, map_size/1 и другие)
синтаксис map.field

Модуль Bitwise также включает несколько битовых операций Erlang как гвардов.

Макросы, составленные из любого сочетания вышеперечисленных гвардов, также являются допустимыми гвардами — например, Integer.is_even/1. Дополнительную информацию см. в разделе «Пользовательские выражения шаблонов и гвардов», показанном ниже.

Зачем нужны гварды

Давайте посмотрим пример использования гварда в разделе функции:

def empty_map?(map) when map_size(map) == 0, do: true
def empty_map?(map) when is_map(map), do: false

Гварды начинаются с оператора when, за которым следует выражение гварда. Раздел будет выполнен только в том случае, если выражение гварда вернёт true. Несколько булевых условий можно объединить операторами and и or.

Написание функции empty_map?/1 только с использованием сопоставления с шаблонами было бы невозможно (так как сопоставление с шаблоном на %{} соответствовало бы любой карте, а не только пустым).

Неуспешные гварды

Раздел функции будет выполнен только в том случае, если его выражение гварда вычисляет значение true. Если возвращается любое другое значение, раздел функции будет пропущен. В частности, гварды не имеют понятия «истинное» или «ложное».

Например, представьте функцию, которая проверяет, что первый элемент списка не nil:

def not_nil_head?([head | _]) when head, do: true
def not_nil_head?(_), do: false

not_nil_head?(["some_value", "another_value"])
#=> false

Несмотря на то, что первый элемент списка не nil, первый раздел для not_nil_head?/1 завершается неудачно, потому что выражение не вычисляет значение true, но вычисляет "some_value", что приводит ко второму разделу, который возвращает false. Чтобы гвард работал правильно, необходимо убедиться, что гвард вычисляет значение true, как показано ниже:

def not_nil_head?([head | _]) when head != nil, do: true
def not_nil_head?(_), do: false

not_nil_head?(["some_value", "another_value"])
#=> true

Ошибки в защитах

В защитах, когда функции обычно генерируют исключения, они вместо этого вызывают сбой защиты.

Например, функция tuple_size/1 работает только с кортежами. Если мы используем её с чем-то другим, возникает ошибка аргумента:

iex> tuple_size("hello")
** (ArgumentError) argument error

Однако, когда она используется в защитах, соответствующая ветвь не будет соответствовать вместо повышения ошибки:

iex> case "hello" do
...>   something when tuple_size(something) == 2 ->
...>     :worked
...>   _anything_else ->
...>     :failed
...> end
:failed

Во многих случаях мы можем воспользоваться этим. В коде выше, мы использовали tuple_size/1 для проверки того, что заданное значение является кортежем и проверки его размера (вместо использования is_tuple(something) and tuple_size(something) == 2).

Однако, если ваша защита имеет несколько условий, таких как проверка кортежей или карт, лучше вызывать функции проверки типов, такие как is_tuple/1, перед tuple_size/1, иначе вся защита потерпит неудачу, если кортеж не задан. В качестве альтернативы, ваша ветвь функции может использовать несколько защит, как показано в следующем разделе.

Несколько защит в одной ветви

Существует дополнительный способ упрощения цепочки or выражений в защитах: Elixir поддерживает запись "нескольких защит" в одной ветви. Следующий код:

def is_number_or_nil(term) when is_integer(term) or is_float(term) or is_nil(term),
  do: :maybe_number
def is_number_or_nil(_other),
  do: :something_else

может быть альтернативно записан как:

def is_number_or_nil(term)
    when is_integer(term)
    when is_float(term)
    when is_nil(term) do
  :maybe_number
end

def is_number_or_nil(_other) do
  :something_else
end

Если каждое выражение защиты всегда возвращает булево значение, обе формы эквивалентны. Однако следует помнить, что если любой вызов функции в защите генерирует исключение, вся защита терпит неудачу. Чтобы проиллюстрировать это, следующая функция не будет обнаруживать пустые кортежи:

defmodule Check do
  # If given a tuple, map_size/1 will raise, and tuple_size/1 will not be evaluated
  def empty?(val) when map_size(val) == 0 or tuple_size(val) == 0, do: true
  def empty?(_val), do: false
end

Check.empty?(%{})
#=> true

Check.empty?({})
#=> false # true was expected!

Это можно исправить, гарантируя, что исключение не возникает, либо с помощью проверок типов, таких как is_map(val) and map_size(val) == 0, либо с помощью нескольких защит, таким образом, если исключение вызывает сбой одной защиты, следующая будет вычислена.

defmodule Check do
  # If given a tuple, map_size/1 will raise, and the second guard will be evaluated
  def empty?(val)
      when map_size(val) == 0
      when tuple_size(val) == 0,
      do: true

  def empty?(_val), do: false
end

Check.empty?(%{})
#=> true

Check.empty?({})
#=> true

Где можно использовать шаблоны и защиты

В приведенных выше примерах мы использовали оператор сопоставления (=) и ветви функций для демонстрации шаблонов и защит соответственно. Вот список встроенных конструкций в Elixir, которые поддерживают шаблоны и защиты.

match?/2:

match?({:ok, value} when value > 0, {:ok, 13})

ветви функций:

def type(term) when is_integer(term), do: :integer
def type(term) when is_float(term), do: :float

case выражения:

case x do
  1 -> :one
  2 -> :two
  n when is_integer(n) and n > 2 -> :larger_than_two
end

анонимные функции (fn/1):

larger_than_two? = fn
  n when is_integer(n) and n > 2 -> true
  n when is_integer(n) -> false
end

for и with поддерживают шаблоны и защиты в левой части <-:
```
for x when x >= 0 <- [1, -2, 3, -4], do: x
```
with также поддерживает ключевое слово else, которое поддерживает сопоставление шаблонов и защиты.
try поддерживает шаблоны и защиты в catch и else
receive поддерживает шаблоны и защиты для сопоставления полученных сообщений.
пользовательские защиты также могут быть определены с помощью defguard/1 и defguardp/1. Пользовательская защита может быть определена только на основе существующих защит.

Обратите внимание, что оператор сопоставления (=) не поддерживает защиты:

{:ok, binary} = File.read("some/file")

Пользовательские шаблоны и выражения защит

Только конструкции, перечисленные на этой странице, разрешены в шаблонах и защитах. Однако мы можем воспользоваться макросами, чтобы написать пользовательские шаблоны и защиты, которые могут упростить наши программы или сделать их более предметно-ориентированными. В конечном счёте, что важно, так это то, что результат макросов сводится к комбинации вышеперечисленных конструкций.

Например, модуль Record в Elixir предоставляет ряд макросов, которые могут использоваться в шаблонах и защитах, позволяющих кортежам иметь именованные поля во время компиляции.

Для определения собственных защит Elixir даже предоставляет удобства в defguard и defguardp. Давайте рассмотрим быстрый пример: мы хотим проверить, является ли аргумент чётным или нечётным целым числом. С помощью сопоставления шаблонов это невозможно, потому что существует бесконечное количество целых чисел, и поэтому мы не можем сопоставить шаблон с каждым из них. Поэтому мы должны использовать защиты. Мы сосредоточимся на проверке чётных чисел, так как проверка нечётных почти идентична.

Такая защита будет выглядеть следующим образом:

def my_function(number) when is_integer(number) and rem(number, 2) == 0 do
  # do stuff
end

Было бы повторяющимся писать каждый раз, когда нам нужна эта проверка. Вместо этого, вы можете использовать defguard/1 и defguardp/1 для создания макросов защиты. Вот пример:

defmodule MyInteger do
  defguard is_even(term) when is_integer(term) and rem(term, 2) == 0
end

и затем:

import MyInteger, only: [is_even: 1]

def my_function(number) when is_even(number) do
  # do stuff
end

Хотя создание пользовательских защит с помощью макросов возможно, рекомендуется определять их с помощью defguard/1 и defguardp/1, которые выполняют дополнительные проверки во время компиляции.

← Предыдущая страница Справочник по операторам

Следующая страница → Справочник по синтаксису

© 2012-2024 The Elixir Team
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.17.2/patterns-and-guards.html