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. Тип рекурсивный. Посмотрите пример одного из возможных представлений двоичной строки "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 в строку.
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): Записывает message в stderr вместе с заданной stacktrace.
write(device \\ :stdio, chardata): Записывает chardata в указанное устройство device.

END_OF_DOCUMENT_MARKER

Типы

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. Операция небезопасна для Юникода.

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

Возвращает:

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

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

binstream()Source

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

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

IO.binstream(:stdio, :line)

binstream(device \\ :stdio, line_or_bytes)Source

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

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

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

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

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

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

binstream/1 была добавлена в 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 для устройств с кодировкой.

Важно: не используйте эту функцию для устройств ввода-вывода в режиме Юникода, так как она запишет неправильные данные. В частности, стандартное устройство ввода-вывода по умолчанию настроено на Юникод, поэтому запись в 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 является устройством Юникода, count означает количество точек кода Юникода для получения. В противном случае, count — это количество байтов для получения.

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

getn(device, prompt, count)Source

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

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

Если устройство ввода-вывода device является устройством Юникода, count означает количество точек кода Юникода для получения. В противном случае, 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()

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

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

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

Примеры

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

iodata_to_binary(iodata)Source

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

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

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

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

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

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

Примеры

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/1 была введена в Elixir v1.12.0, а stream/2 доступна с v1.0.0.

Примеры

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

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

warn(message)Source

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

Выводит message в stderr вместе с текущим стеком вызовов.

Возвращает :ok при успешном выполнении.

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

Примеры

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

warn(message, stacktrace)Source

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

Выводит message в stderr вместе с указанным stacktrace.

Функция также сообщает компилятору о выводе предупреждения (в случае, если включена опция --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

Настройки IO

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

Данные IO

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

Chardata

Сводка

Типы

Функции

Типы

chardata()Source

device()Source

nodata()Source

Функции

binread(device \\ :stdio, line_or_chars)Source

binstream()Source

binstream(device \\ :stdio, line_or_bytes)Source

binwrite(device \\ :stdio, iodata)Source

chardata_to_string(chardata)Source

Примеры

getn(prompt, count \\ 1)Source

getn(device, prompt, count)Source

gets(device \\ :stdio, prompt)Source

Примеры

inspect(item, opts \\ [])Source

Примеры

inspect(device, item, opts)Source

iodata_length(iodata)Source

Примеры

iodata_to_binary(iodata)Source

Примеры

puts(device \\ :stdio, item)Source

Примеры

read(device \\ :stdio, line_or_chars)Source

stream()Source

stream(device \\ :stdio, line_or_codepoints)Source

Примеры

warn(message)Source

Примеры

warn(message, stacktrace)Source

Примеры

write(device \\ :stdio, chardata)Source

Примеры

IO