StringIO

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

Устройство ввода-вывода StringIO может быть передано в качестве «устройства» большинству функций в модуле IO.

Примеры

iex> {:ok, pid} = StringIO.open("foo")
iex> IO.read(pid, 2)
"fo"

Обзор

Функции

child_spec(init_arg)

Возвращает спецификацию для запуска этого модуля под управлением диспетчера.

close(pid)

Останавливает устройство ввода-вывода и возвращает оставшиеся буферы ввода-вывода.

contents(pid)

Возвращает текущие буферы ввода-вывода для данного устройства ввода-вывода.

flush(pid)

Очищает буфер вывода и возвращает его текущее содержимое.

open(string, options_or_function \\ [])

Создаёт устройство ввода-вывода.

open(string, options, function)

Создаёт устройство ввода-вывода.

Функции

child_spec(init_arg)

Возвращает спецификацию для запуска этого модуля под управлением диспетчера.

См. Supervisor.

close(pid)

close(pid()) :: {:ok, {binary(), binary()}}

Останавливает устройство ввода-вывода и возвращает оставшиеся буферы ввода-вывода.

Примеры

iex> {:ok, pid} = StringIO.open("in")
iex> IO.write(pid, "out")
iex> StringIO.close(pid)
{:ok, {"in", "out"}}

contents(pid)

contents(pid()) :: {binary(), binary()}

Возвращает текущие буферы ввода-вывода для данного устройства ввода-вывода.

Примеры

iex> {:ok, pid} = StringIO.open("in")
iex> IO.write(pid, "out")
iex> StringIO.contents(pid)
{"in", "out"}

flush(pid)

flush(pid()) :: binary()

Очищает буфер вывода и возвращает его текущее содержимое.

Примеры

iex> {:ok, pid} = StringIO.open("in")
iex> IO.write(pid, "out")
iex> StringIO.flush(pid)
"out"
iex> StringIO.contents(pid)
{"in", ""}

open(string, options_or_function \\ [])

open(binary(), keyword()) :: {:ok, pid()}

open(binary(), (pid() -> res)) :: {:ok, res} when res: var

Создаёт устройство ввода-вывода.

string будет начальным вводом для вновь созданного устройства.

options_or_function может быть списком ключевых параметров или функцией.

Если параметры предоставлены, результатом будет {:ok, pid}, возвращая созданное устройство ввода-вывода. Параметр :capture_prompt, когда установлен в true, включает приглашения (которые указаны как аргументы функциям IO.get*) в выходные данные устройства.

Если функция предоставлена, устройство будет создано и передано в функцию. По возвращении из функции устройство будет закрыто. Конечным результатом будет кортеж с :ok и результатом функции.

Примеры

iex> {:ok, pid} = StringIO.open("foo")
iex> IO.gets(pid, ">")
"foo"
iex> StringIO.contents(pid)
{"", ""}

iex> {:ok, pid} = StringIO.open("foo", capture_prompt: true)
iex> IO.gets(pid, ">")
"foo"
iex> StringIO.contents(pid)
{"", ">"}

iex> StringIO.open("foo", fn pid ->
...>   input = IO.gets(pid, ">")
...>   IO.write(pid, "The input was #{input}")
...>   StringIO.contents(pid)
...> end)
{:ok, {"", "The input was foo"}}

open(string, options, function)

open(binary(), keyword(), (pid() -> res)) :: {:ok, res} when res: var

Создаёт устройство ввода-вывода.

string будет начальным вводом для вновь созданного устройства.

Если параметр :capture_prompt установлен в true, приглашения (указанные как аргументы функциям IO.get*) будут захвачены в выходные данные.

Устройство будет создано и передано заданной функции. По возвращении из функции устройство будет закрыто. Конечный результат будет кортежем с :ok и результатом функции.

Примеры

iex> StringIO.open("foo", [], fn pid ->
...>   input = IO.gets(pid, ">")
...>   IO.write(pid, "The input was #{input}")
...>   StringIO.contents(pid)
...> end)
{:ok, {"", "The input was foo"}}

iex> StringIO.open("foo", [capture_prompt: true], fn pid ->
...>   input = IO.gets(pid, ">")
...>   IO.write(pid, "The input was #{input}")
...>   StringIO.contents(pid)
...> end)
{:ok, {"", ">The input was foo"}}