Исходный код IO

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

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

Большинство функций ожидают данные символов. В случае, если предоставлен другой тип, функции преобразуют эти типы в строку через протокол String.Chars (как показано в типах спецификаций). Для получения дополнительной информации о данных символов см. раздел «Данные 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, основанных на вводе-выводе, таких как :gen_tcp и IO, принимают данные IO и записывают их непосредственно в сокет без преобразования в двоичные данные.

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

Данные символов

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

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

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

Если вместо этого мы используем данные символов, всё будет работать как ожидается:

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

Описание

Функции

binread(device \\ :stdio, line_or_chars): Читает из устройства ввода/вывода device. Операция небезопасна для Unicode.
binstream(): Возвращает необработанный, основанный на строках IO.Stream для :stdio. Операция небезопасна для Unicode.
binstream(device \\ :stdio, line_or_bytes): Преобразует устройство ввода/вывода device в IO.Stream. Операция небезопасна для Unicode.
binwrite(device \\ :stdio, iodata): Записывает iodata в заданное device.
chardata_to_string(chardata): Преобразует данные символов в строку.
getn(prompt, count \\ 1): Получает количество байтов из устройства ввода/вывода :stdio.
getn(device, prompt, count): Получает количество байтов с устройства ввода/вывода device.
gets(device \\ :stdio, prompt): Читает строку с устройства ввода/вывода device.
inspect(item, opts \\ []): Просматривает и записывает заданный item в устройство.
inspect(device, item, opts): Просматривает item в соответствии с заданными параметрами с использованием устройства ввода/вывода device.
iodata_length(iodata): Возвращает размер данных IO.
iodata_to_binary(iodata): Преобразует данные IO в двоичные данные.
puts(device \\ :stdio, item): Записывает item в заданное device, аналогично write/2, но добавляет перевод строки в конце.
read(device \\ :stdio, line_or_chars): Читает с устройства ввода/вывода device.
stream(): Возвращает основанный на строках IO.Stream для :stdio.
stream(device \\ :stdio, line_or_codepoints): Преобразует устройство ввода/вывода device в IO.Stream.
warn(message): Записывает message в stderr вместе с текущим стеком вызовов.
warn(message, stacktrace_info): Записывает message в stderr вместе с указанным stacktrace_info.
write(device \\ :stdio, chardata): Записывает chardata в заданное device.

Типы

chardata()Source

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

device()Source

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

nodata()Source

@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

@spec binstream() :: Enumerable.t(binary())

Возвращает сырой, основанный на строках 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.

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

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

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

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

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

binwrite(device \\ :stdio, iodata)Source

@spec binwrite(device(), iodata()) :: :ok

Записывает 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-тома

Примеры

Чтобы отобразить "Как вас зовут?" как приглашение и дождаться ввода пользователя:

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>>

END_OF_DOCUMENT_MARKER

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.

Прочитанные данные обрабатываются посимвольно, если указано :line, или строка за строкой, если задано :line, или до тех пор, пока не будет достигнут конец файла :eof.

Возвращает:

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

stream()Source

@spec stream() :: Enumerable.t(String.t())

Возвращает 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 должно быть одним из:

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

Эта функция уведомляет компилятор о выводе предупреждения и генерирует диагностику компилятора (Code.diagnostic/1). Диагностика будет содержать точную информацию о файле и местоположении, если указана структура Macro.Env или эти значения были переданы в виде списка ключевых слов, но не для стеков вызовов, так как они часто неточны.

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

Примеры

IO.warn("variable bar is unused", module: MyApp, function: {:main, 1}, line: 4, file: "my_app.ex")
#=> 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