IO

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

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

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

Функции, начинающиеся с bin, ожидают iodata в качестве аргумента, т.е. двоичные данные или списки байтов и двоичные данные.

IO-устройства

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

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

• :stderr - сокращение для именованного процесса :standard_error в Erlang

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

Краткое описание

Типы

chardata()

device()

nodata()

Функции

binread(device \\ :stdio, line_or_chars)

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

binstream(device, line_or_bytes)

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

binwrite(device \\ :stdio, item)

Записывает item в виде двоичных данных в заданное device. Преобразование Unicode не происходит. Операция небезопасна для Unicode.

chardata_to_string(string)

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

Возвращает размер iodata.

iodata_to_binary(item)

Преобразует iodata (список целых чисел, представляющих байты, списки и двоичные данные) в двоичные данные. Операция небезопасна для Unicode.

puts(device \\ :stdio, item)

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

read(device \\ :stdio, line_or_chars)

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

stream(device, line_or_codepoints)

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

warn(message)

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

warn(message, stacktrace)

Записывает message в stderr вместе с заданной stacktrace.

write(device \\ :stdio, item)

Записывает item в заданное device.

Типы

chardata()

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

device()

device() :: atom() | pid()

nodata()

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

Функции

binread(device \\ :stdio, line_or_chars)

binread(device(), :all | :line | non_neg_integer()) :: iodata() | nodata()

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

Итерация device выполняется по заданному количеству байтов или строкам по строкам, если задан :line. В противном случае, если задан :all, возвращается весь device.

Возвращает:

• data - выходные байты

• :eof - был достигнут конец файла

• {:error, reason} - другая (редкая) ошибка; например, {:error, :estale} при чтении с NFS-тома

Если задан :all, :eof никогда не возвращается, а пустая строка в случае, если устройство достигло EOF.

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

binstream(device, line_or_bytes)

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

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

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

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

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

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

binwrite(device \\ :stdio, item)

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

Записывает item в виде двоичных данных в заданное device. Преобразование Unicode не происходит. Операция небезопасна для Unicode.

См. write/2 для получения дополнительной информации.

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

chardata_to_string(string)

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

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

getn(chardata() | String.Chars.t(), pos_integer()) :: chardata() | nodata()

getn(device(), chardata() | String.Chars.t()) :: chardata() | nodata()

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

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

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

getn(device, prompt, count)

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

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

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

Возвращает:

• data - введённые символы

• :eof - был достигнут конец файла

• {:error, reason} - другая (редкая) ошибка; например, {:error, :estale} при чтении с NFS-тома

gets(device \\ :stdio, prompt)

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

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

Возвращает:

• data - символы в строке, завершённой символом новой строки (LF) или концом файла (EOF)

• :eof - был достигнут конец файла

• {:error, reason} - другая (редкая) ошибка; например, {:error, :estale} при чтении с NFS-тома

Примеры

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

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

inspect(item, opts \\ [])

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)

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

Проверяет item согласно заданным параметрам с помощью IO device.

Полный список параметров см. в inspect/2.

iodata_length(item)

iodata_length(iodata()) :: non_neg_integer()

Возвращает размер iodata.

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

Примеры

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

iodata_to_binary(item)

iodata_to_binary(iodata()) :: binary()

Преобразует iodata (список целых чисел, представляющих байты, списки и двоичные данные) в двоичный тип. Операция не безопасна для Unicode.

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

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

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

Примеры

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)

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)

read(device(), :all | :line | non_neg_integer()) :: chardata() | nodata()

Считывает данные из IO device.

device итерируется по заданному количеству символов или строкам по строкам, если указано :line. В альтернативном случае, если указано :all, возвращается весь device.

Возвращает:

• data — символы вывода

• :eof — достигнут конец файла

• {:error, reason} — другая (редкая) ошибка; например, {:error, :estale} при чтении с NFS-тома

Если указано :all, :eof никогда не возвращается, но возвращается пустая строка, если устройство достигло конца файла.

stream(device, line_or_codepoints)

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

Преобразует IO device в IO.Stream.

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

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

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

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

Примеры

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

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

warn(message)

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

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

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

Примеры

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

warn(message, stacktrace)

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, item)

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

Записывает item в указанный device.

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

Примеры

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

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