IO

Функции, обрабатывающие ввод/вывод (IO).

Многие функции в этом модуле ожидают в качестве аргумента устройство ввода/вывода. Устройство ввода/вывода должно быть PID или атомом, представляющим процесс. Для удобства Elixir предоставляет :stdio и :stderr в качестве сокращений для :standard_io и :standard_error Erlang.

Большинство функций ожидают chardata. В случае, если будет передан другой тип, функции преобразуют эти типы в строку с помощью протокола String.Chars (как показано в типовредефинициях). Дополнительную информацию о chardata см. в разделе "Данные IO" ниже.

Устройства ввода/вывода

Устройство ввода/вывода может быть атомом или PID. Если это атом, атом должен быть именем зарегистрированного процесса. Кроме того, Elixir предоставляет два сокращения:

:stdio — сокращение для :standard_io, которое отображается на текущий Process.group_leader/0 в Erlang
:stderr — сокращение для именованного процесса :standard_error в Erlang

Устройства ввода/вывода сохраняют свою позицию, что означает, что последующие вызовы функций чтения или записи будут начинаться с места, где устройство было в последний раз обработано. Позицию файлов можно изменить с помощью функции :file.position/2.

Данные IO

Данные IO — это тип данных, который можно использовать в качестве более эффективной альтернативы бинарным данным в определенных ситуациях.

Значение типа Данные IO — это бинарные данные или список, содержащий байты (целые числа в диапазоне 0..255) или вложенные данные IO. Тип рекурсивный. Давайте рассмотрим пример одного из возможных типов данных IO, представляющего бинарные данные "hello".

[?h, "el", ["l", [?o]]]

Встроенный тип iodata/0 определяется через iolist/0. Список IO такой же, как данные IO, но он не допускает бинарных данных на верхнем уровне (но бинарные данные все еще разрешены в самом списке).

Сценарии использования данных IO

Данные IO существуют, потому что часто вам нужно выполнять много операций добавления к небольшим частям бинарных данных, чтобы создать большую бинарную строку. Однако в Erlang и Elixir конкатенация бинарных строк приведет к копированию конкатенированных бинарных строк в новую бинарную строку.

def email(username, domain) do
  username <> "@" <> domain
end

В этой функции создание адреса электронной почты приведет к копированию бинарных строк username и domain. Теперь представьте, что вы хотите использовать полученный адрес электронной почты в другой бинарной строке:

def welcome_message(name, username, domain) do
  "Welcome #{name}, your email is: #{email(username, domain)}"
end

IO.puts(welcome_message("Meg", "meg", "example.com"))
#=> "Welcome Meg, your email is: meg@example.com"

Каждый раз, когда вы конкатенируете бинарные строки или используете интерполяцию (#{}), вы создаете копии этих бинарных строк. Однако во многих случаях вам не нужна полная бинарная строка во время ее создания, а только в конце, чтобы напечатать ее или отправить куда-то. В таких случаях вы можете создать бинарную строку, создав данные IO:

def email(username, domain) do
  [username, ?@, domain]
end

def welcome_message(name, username, domain) do
  ["Welcome ", name, ", your email is: ", email(username, domain)]
end

IO.puts(welcome_message("Meg", "meg", "example.com"))
#=> "Welcome Meg, your email is: meg@example.com"

Создание данных IO обходится дешевле, чем конкатенация бинарных строк. Конкатенация нескольких частей данных IO означает просто их объединение в списке, так как данные IO могут быть произвольно вложены, и это дешевая и эффективная операция. Большинство API на основе IO, таких как :gen_tcp и IO, принимают данные IO и записывают их в сокет напрямую, не преобразовывая их в бинарные данные.

Один недостаток данных IO заключается в том, что вы не можете выполнять такие операции, как сопоставление с образцом на первой части данных IO, как это можно сделать с бинарными данными, потому что вы обычно не знаете структуру данных IO. В таких случаях вам может потребоваться преобразовать их в бинарные данные, вызвав iodata_to_binary/1, что достаточно эффективно, поскольку реализовано нативно в C. Другие функции, такие как вычисление длины данных IO, могут быть вычислены непосредственно на данных IO, вызвав iodata_length/1.

Chardata

Erlang и Elixir также имеют понятие chardata/0. Chardata очень похожи на данные IO: единственное различие заключается в том, что целые числа в данных IO представляют байты, а целые числа в chardata представляют кодовые точки Unicode. Байты (byte/0) — это целые числа в диапазоне 0..255, а кодовые точки Unicode (char/0) — это целые числа в диапазоне 0..0x10FFFF. Модуль IO предоставляет функцию chardata_to_string/1 для chardata в качестве "аналога" функции iodata_to_binary/1 для данных IO.

Если вы попытаетесь использовать iodata_to_binary/1 с chardata, это приведет к ошибке аргумента. Например, давайте попробуем поместить кодовую точку, которая не может быть представлена одним байтом, например ?π, в данные IO:

IO.iodata_to_binary(["The symbol for pi is: ", ?π])
#=> ** (ArgumentError) argument error

Если мы используем chardata, все будет работать как ожидалось:

iex> IO.chardata_to_string(["The symbol for pi is: ", ?π])
"The symbol for pi is: π"

Функции

binread(device \\ :stdio, line_or_chars): Читает из устройства IO device. Операция небезопасна для Unicode.
binstream(): Возвращает простой, основанный на строках, IO.Stream на :stdio. Операция небезопасна для Unicode.
binstream(device \\ :stdio, line_or_bytes): Преобразует устройство IO device в IO.Stream. Операция небезопасна для Unicode.
binwrite(device \\ :stdio, iodata): Записывает iodata в заданное device.
chardata_to_string(chardata): Преобразует chardata в строку.

END_OF_DOCUMENT_MARKER

chardata()Исходный код

@type chardata() ::
  String.t() | maybe_improper_list(char() | chardata(), String.t() | [])

device()Исходный код

@type device() :: atom() | pid()

nodata()Исходный код

@type nodata() :: {:error, term()} | :eof

binread(device \\ :stdio, line_or_chars)Source

@spec binread(device(), :eof | :line | non_neg_integer()) :: iodata() | nodata()

Считывает данные из устройства ввода-вывода device. Операция не безопасна для Unicode.

Операция device выполняется согласно аргументу line_or_chars:

Если line_or_chars является целым числом, оно представляет количество байтов. Устройство считывает указанное количество байтов.
Если line_or_chars равно :line, устройство считывается построчно.
Если line_or_chars равно :eof, устройство считывается до :eof. line_or_chars может быть только :eof начиная с Elixir 1.13.0. :eof заменяет устаревшую функцию :all, с разницей в том, что :all возвращает "" в конце файла, а :eof возвращает само значение :eof.

Возвращает:

data - считанные байты
:eof - обнаружен конец файла
{:error, reason} - другие (редкие) условия ошибки; например, {:error, :estale} при чтении с NFS-тома

Примечание: не используйте эту функцию с устройствами ввода-вывода в режиме Unicode, так как она вернёт неверный результат.

binstream()Source

Возвращает сырой, основанный на строках, IO.Stream для :stdio. Операция не безопасна для Unicode.

Эквивалентно:

IO.binstream(:stdio, :line)

binstream(device \\ :stdio, line_or_bytes)Source

@spec binstream(device(), :line | pos_integer()) :: Enumerable.t()

Преобразует устройство ввода-вывода device в IO.Stream. Операция не безопасна для Unicode.

A IO.Stream реализует как Enumerable, так и Collectable, что позволяет использовать его как для чтения, так и для записи.

Устройство ввода-вывода перебирается по заданному количеству байтов или построчно, если указано :line. Это читает из устройства ввода-вывода как сырой двоичный файл.

Обратите внимание, что поток ввода-вывода имеет побочные эффекты, и каждый раз при проходе по потоку вы можете получить разные результаты.

Наконец, не используйте эту функцию с устройствами ввода-вывода в режиме Unicode, так как она вернёт неверный результат.

binstream/0 была введена в Elixir v1.12.0, а binstream/2 доступна с версии v1.0.0.

binwrite(device \\ :stdio, iodata)Source

@spec binwrite(device(), iodata()) :: :ok | {:error, term()}

Записывает iodata в данное устройство device.

Эта операция предназначена для использования с "сырыми" устройствами, которые запускаются без кодировки. Указанные данные iodata записываются в устройство без преобразований. Дополнительную информацию о данных ввода-вывода см. в разделе "Данные ввода-вывода" в документации модуля.

Используйте write/2 для устройств с кодировкой.

Важно: не используйте эту функцию с устройствами ввода-вывода в режиме Unicode, так как она запишет неверные данные. В частности, стандартное устройство ввода-вывода по умолчанию настроено на Unicode, поэтому запись в stdio с этой функцией, вероятно, приведёт к отправке неверных данных.

chardata_to_string(chardata)Source

@spec chardata_to_string(chardata()) :: String.t()

Преобразует chardata в строку.

Дополнительную информацию о chardata см. в разделе "Chardata" в документации модуля.

В случае неудачного преобразования генерируется исключение UnicodeConversionError. Если передаётся строка, возвращается сама строка.

Примеры

iex> IO.chardata_to_string([0x00E6, 0x00DF])
"æß"

iex> IO.chardata_to_string([0x0061, "bc"])
"abc"

iex> IO.chardata_to_string("string")
"string"

getn(prompt, count \\ 1)Source

@spec getn(
  device() | chardata() | String.Chars.t(),
  pos_integer() | :eof | chardata() | String.Chars.t()
) :: chardata() | nodata()

Считывает заданное количество байтов с устройства ввода-вывода :stdio.

Если устройство :stdio является устройством Unicode, count подразумевает количество символов Unicode для получения. В противном случае, count представляет количество байтов для получения.

См. IO.getn/3 для описания возвращаемых значений.

getn(device, prompt, count)Source

@spec getn(device(), chardata() | String.Chars.t(), pos_integer() | :eof) ::
  chardata() | nodata()

Считывает заданное количество байтов с устройства ввода-вывода device.

Если устройство ввода-вывода device является устройством Unicode, count подразумевает количество символов Unicode для получения. В противном случае, count представляет количество байтов для получения.

Возвращает:

data - входные символы
:eof - обнаружен конец файла
{:error, reason} - другие (редкие) условия ошибки; например, {:error, :estale} при чтении с NFS-тома

gets(device \\ :stdio, prompt)Source

@spec gets(device(), chardata() | String.Chars.t()) :: chardata() | nodata()

Считывает строку с устройства ввода-вывода device.

Возвращает:

data - символы в строке, завершённой символом новой строки (LF) или концом файла (EOF)
:eof - обнаружен конец файла
{:error, reason} - другие (редкие) условия ошибки; например, {:error, :estale} при чтении с NFS-тома

Примеры

Чтобы отобразить "What is your name?" как запрос и ожидать ввода пользователя:

IO.gets("What is your name?\n")

inspect(item, opts \\ [])Source

@spec inspect(
  item,
  keyword()
) :: item
when item: var

Просматривает и записывает данное item на устройство.

Важно отметить, что оно возвращает заданное item без изменений. Это позволяет "просматривать" значения, вставляя вызов IO.inspect/2 практически в любом месте вашего кода, например, посреди цепочки операций.

Включает форматирование по умолчанию с шириной 80 символов. Ширина может быть изменена путём явного указания опции :width.

Вывод может быть дополнен меткой, передав опцию :label для лёгкого отличия от других вызовов IO.inspect/2. Метка будет напечатана перед просматриваемым item.

См. Inspect.Opts для полного списка оставшихся опций форматирования.

Примеры

IO.inspect(<<0, 1, 2>>, width: 40)

Выводит:

<<0, 1, 2>>

Мы можем использовать опцию :label для форматирования вывода:

IO.inspect(1..100, label: "a wonderful range")

Выводит:

a wonderful range: 1..100

Опция :label особенно полезна при использовании цепочек операций:

[1, 2, 3]
|> IO.inspect(label: "before")
|> Enum.map(&(&1 * 2))
|> IO.inspect(label: "after")
|> Enum.sum()

Выводит:

before: [1, 2, 3]
after: [2, 4, 6]

inspect(device, item, opts)Source

@spec inspect(device(), item, keyword()) :: item when item: var

Просматривает item в соответствии с заданными параметрами, используя устройство ввода-вывода device.

См. inspect/2 для полного списка параметров.

iodata_length(iodata)Source

@spec iodata_length(iodata()) :: non_neg_integer()

Возвращает размер данных ввода-вывода.

Дополнительную информацию о данных ввода-вывода см. в разделе "Данные ввода-вывода" в документации модуля.

Встроенная компилятором.

Примеры

iex> IO.iodata_length([1, 2 | <<3, 4>>])
4

iodata_to_binary(iodata)Source

@spec iodata_to_binary(iodata()) :: binary()

Преобразует данные ввода-вывода в двоичный тип.

Операция не безопасна для Unicode.

Обратите внимание, что эта функция обрабатывает целые числа в данных ввода-вывода как сырые байты и не выполняет никаких преобразований кодировки. Если вы хотите преобразовать список символов в строку UTF-8, используйте chardata_to_string/1 вместо этого. Дополнительную информацию о данных ввода-вывода и chardata см. в разделе "Данные ввода-вывода" в документации модуля.

Если функция получает двоичный тип, возвращается тот же двоичный тип.

Встроенная компилятором.

Примеры

iex> bin1 = <<1, 2, 3>>
iex> bin2 = <<4, 5>>
iex> bin3 = <<6>>
iex> IO.iodata_to_binary([bin1, 1, [2, 3, bin2], 4 | bin3])
<<1, 2, 3, 1, 2, 3, 4, 5, 4, 6>>

iex> bin = <<1, 2, 3>>
iex> IO.iodata_to_binary(bin)
<<1, 2, 3>>

puts(device \\ :stdio, item)Source

@spec puts(device(), chardata() | String.Chars.t()) :: :ok

Записывает item в заданный device, аналогично write/2, но добавляет символ новой строки в конце.

По умолчанию, device — это стандартный вывод. Возвращает :ok в случае успеха.

Примеры

IO.puts("Hello World!")
#=> Hello World!

IO.puts(:stderr, "error")
#=> error

read(device \\ :stdio, line_or_chars)Source

@spec read(device(), :eof | :line | non_neg_integer()) :: chardata() | nodata()

Читает из устройства ввода-вывода device.

Данный device просматривается по заданному количеству символов, строка за строкой, если указано :line, или до тех пор, пока :eof.

Возвращает:

data — символы вывода
:eof — достигнут конец файла
{:error, reason} — другая (редкая) ошибка; например, {:error, :estale} при чтении с NFS-тома

stream()Source

Возвращает основанный на строках IO.Stream на :stdio.

Эквивалентно:

IO.stream(:stdio, :line)

stream(device \\ :stdio, line_or_codepoints)Source

@spec stream(device(), :line | pos_integer()) :: Enumerable.t()

Преобразует устройство ввода-вывода device в IO.Stream.

IO.Stream реализует как Enumerable, так и Collectable, что позволяет использовать его для чтения и записи.

Данный device просматривается по заданному количеству символов или строка за строкой, если указано :line.

Читает из устройства ввода-вывода как UTF-8. Обратитесь к IO.binstream/2 для обработки устройства ввода-вывода как обычного двоичного.

Обратите внимание, что поток ввода-вывода имеет побочные эффекты, и каждый раз, когда вы просматриваете поток, вы можете получить разные результаты.

stream/0 был представлен в Elixir v1.12.0, а stream/2 доступен с v1.0.0.

Примеры

Вот пример того, как мы имитируем сервер эха из командной строки:

Enum.each(IO.stream(:stdio, :line), &IO.write(&1))

Еще один пример, где вам может потребоваться собирать пользовательский ввод в каждой новой строке и завершать ввод на пустой строке, а затем удалять избыточные символы новой строки ("\n"):

IO.stream(:stdio, :line)
|> Enum.take_while(&(&1 != "\n"))
|> Enum.map(&String.replace(&1, "\n", ""))

warn(message)Source

@spec warn(chardata() | String.Chars.t()) :: :ok

Записывает message в stderr вместе с текущим стеком вызовов.

Возвращает :ok в случае успеха.

Не вызывайте эту функцию в конце другой функции. Из-за оптимизации хвостовой рекурсии запись в стек вызовов не будет добавлена, и стек вызовов будет неправильно обрезан. Поэтому убедитесь, что за вызовом IO.warn/1 следует хотя бы одно выражение (или атом, например, :ok).

Примеры

IO.warn("variable bar is unused")
#=> warning: variable bar is unused
#=>   (iex) evaluator.ex:108: IEx.Evaluator.eval/4

warn(message, stacktrace_info)Source

@spec warn(
  chardata() | String.Chars.t(),
  Exception.stacktrace() | keyword() | Macro.Env.t()
) :: :ok

Записывает message в stderr вместе с указанной информацией о стеке вызовов stacktrace_info.

stacktrace_info должно быть одним из:

__STACKTRACE__, где все записи в стеке вызовов будут включены в сообщение об ошибке
структура Macro.Env (с версии v1.14.0), где будет использоваться единственная запись стека вызовов из среды компиляции
список ключевых слов с по крайней мере опцией :file, представляющей собой одну запись стека вызовов (с версии v1.14.0). Также поддерживаются опции :line, :module, :function

Эта функция также уведомляет компилятор о том, что предупреждение было выведено (в случае, если --warnings-as-errors был включён). Возвращает :ok в случае успеха.

Примеры

stacktrace = [{MyApp, :main, 1, [file: 'my_app.ex', line: 4]}]
IO.warn("variable bar is unused", stacktrace)
#=> warning: variable bar is unused
#=>   my_app.ex:4: MyApp.main/1

write(device \\ :stdio, chardata)Source

@spec write(device(), chardata() | String.Chars.t()) :: :ok

Записывает chardata в указанное device.

По умолчанию, device — это стандартный вывод.

Примеры

IO.write("sample")
#=> sample

IO.write(:stderr, "error")
#=> error