IO

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

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

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

Устройства IO

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

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

Устройства IO сохраняют своё положение, что означает, что последующие вызовы функций чтения или записи начнут работу с места, где устройство было в последний раз обработано. Положение файлов может быть изменено с помощью функции :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 представляют кодовые точки Юникода. Байты (byte/0) — это целые числа в диапазоне 0..255, а кодовые точки Юникода (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. Операция небезопасна для Юникода.
binstream(): Возвращает сырой, основанный на строках IO.Stream на :stdio. Операция небезопасна для Юникода.
binstream(device \\ :stdio, line_or_bytes): Преобразует устройство IO device в IO.Stream. Операция небезопасна для Юникода.
binwrite(device \\ :stdio, iodata): Записывает iodata в указанное устройство device.
chardata_to_string(chardata): Преобразует chardata в строку.
getn(prompt, count \\ 1): Получает определённое количество байтов с устройства IO :stdio.
getn(device, prompt, count): Получает определённое количество байтов с указанного устройства IO device.
gets(device \\ :stdio, prompt): Считывает строку с устройства IO device.
inspect(item, opts \\ []): Проверяет и записывает указанный item на устройство.
inspect(device, item, opts): Проверяет item согласно заданным параметрам, используя устройство IO device.
iodata_length(iodata): Возвращает размер данных IO.
iodata_to_binary(iodata): Преобразует данные IO в двоичные данные
puts(device \\ :stdio, item): Записывает item в указанное устройство device, подобно write/2, но добавляет символ новой строки в конце.
read(device \\ :stdio, line_or_chars): Считывает данные с устройства IO device.
stream(): Возвращает основанный на строках IO.Stream на :stdio.
stream(device \\ :stdio, line_or_codepoints): Преобразует устройство IO device в IO.Stream.
warn(message): Записывает message в stderr вместе со текущей трассировкой стека.
warn(message, stacktrace_info): Записывает message в stderr вместе с указанной stacktrace_info.
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. Операция не поддерживает 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.

Поток 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

Примеры

Чтобы отобразить «Какое ваше имя?» в качестве подсказки и дождаться ввода:

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

Преобразует IO 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))

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