Модуль Out_channel

module Out_channel: sig .. end

Каналы вывода.

Since 4.14.0

type t = out_channel

Тип канала вывода.

type open_flag = open_flag =

`\|`	`Open_rdonly`	`(*`	открыт для чтения.	`*)`
`\|`	`Open_wronly`	`(*`	открыт для записи.	`*)`
`\|`	`Open_append`	`(*`	открыт для добавления: всегда записывает в конец файла.	`*)`
`\|`	`Open_creat`	`(*`	создаёт файл, если он не существует.	`*)`
`\|`	`Open_trunc`	`(*`	очищает файл, если он уже существует.	`*)`
`\|`	`Open_excl`	`(*`	возвращает ошибку, если Open_creat и файл уже существует.	`*)`
`\|`	`Open_binary`	`(*`	открывает в двоичном режиме (без преобразований).	`*)`
`\|`	`Open_text`	`(*`	открывает в текстовом режиме (может выполнять преобразования).	`*)`
`\|`	`Open_nonblock`	`(*`	открывает в режиме без ожидания.	`*)`

Режимы открытия для Out_channel.open_gen.

val stdout : t

Стандартный вывод для процесса.

val stderr : t

Стандартный вывод ошибок для процесса.

val open_bin : string -> t

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

val open_text : string -> t

То же, что и Out_channel.open_bin, но файл открывается в текстовом режиме, так что перевод символов новой строки происходит во время записи. В операционных системах, которые не различают текстовый и двоичный режимы, эта функция ведёт себя как Out_channel.open_bin.

val open_gen : open_flag list -> int -> string -> t

open_gen mode perm filename открывает именованный файл для записи, как описано выше. Дополнительный аргумент mode указывает режим открытия. Дополнительный аргумент perm указывает права доступа к файлу, если файл нужно создать. Out_channel.open_text и Out_channel.open_bin являются специальными случаями этой функции.

val with_open_bin : string -> (t -> 'a) -> 'a

with_open_bin fn f открывает канал oc на файле fn и возвращает f oc. После того, как f вернётся, либо с значением, либо с возбуждением исключения, oc гарантированно будет закрыт.

val with_open_text : string -> (t -> 'a) -> 'a

Как Out_channel.with_open_bin, но канал открыт в текстовом режиме (см. Out_channel.open_text).

val with_open_gen : open_flag list -> int -> string -> (t -> 'a) -> 'a

Как Out_channel.with_open_bin, но можно указать режим открытия и права доступа к файлу, если файл нужно создать (см. Out_channel.open_gen).

val seek : t -> int64 -> unit

seek chan pos устанавливает текущую позицию записи в pos для канала chan. Это работает только для обычных файлов. Для файлов других типов (например, терминалов, каналов и сокетов) поведение не определено.

val pos : t -> int64

Возвращает текущую позицию записи для данного канала. Не работает с каналами, открытыми с флагом Open_append (возвращает неопределённые результаты).
Для файлов, открытых в текстовом режиме в Windows, возвращаемая позиция является приблизительной (из-за преобразования конца строки); в частности, сохранение текущей позиции с помощью Out_channel.pos, а затем возврат к этой позиции с помощью Out_channel.seek не сработает. Для надёжного и переносимого функционирования этого фрагмента кода файл должен быть открыт в двоичном режиме.

val length : t -> int64

Возвращает размер (количество символов) обычного файла, на котором открыт данный канал. Если канал открыт на файле, который не является обычным файлом, результат не имеет смысла.

val close : t -> unit

Закрывает данный канал, сбрасывая все буферизованные операции записи. Функции вывода возбуждают исключение Sys_error при применении к закрытому каналу вывода, за исключением Out_channel.close и Out_channel.flush, которые ничего не делают, если применяются к уже закрытому каналу. Обратите внимание, что Out_channel.close может возбудить Sys_error если операционная система сигнализирует об ошибке при сбросе или закрытии.

val close_noerr : t -> unit

То же, что и Out_channel.close, но игнорирует все ошибки.

val flush : t -> unit

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

val flush_all : unit -> unit

Сбрасывает все открытые каналы вывода; игнорирует ошибки.

val output_char : t -> char -> unit

Записывает символ в данный канал вывода.

val output_byte : t -> int -> unit

Записывает целое 8-битное число (как одиночный символ с этим кодом) в данный канал вывода. Заданное целое число берётся по модулю 256.

val output_string : t -> string -> unit

Записывает строку в данный канал вывода.

val output_bytes : t -> bytes -> unit

Записывает последовательность байтов в данный канал вывода.

val output : t -> bytes -> int -> int -> unit

output oc buf pos len записывает len символов из последовательности байтов buf, начиная с смещения pos, в данный канал вывода oc.

Raises Invalid_argument если pos и len не обозначают допустимый диапазон buf.

val output_substring : t -> string -> int -> int -> unit

То же, что и Out_channel.output, но в качестве аргумента используется строка вместо последовательности байтов.

val set_binary_mode : t -> bool -> unit

set_binary_mode oc true устанавливает канал oc в двоичный режим: никакие преобразования не происходят во время вывода.
set_binary_mode oc false устанавливает канал oc в текстовый режим: в зависимости от операционной системы, некоторые преобразования могут происходить во время вывода. Например, в Windows концы строк будут переведены из \n в \r\n.
Эта функция не имеет эффекта в операционных системах, которые не различают текстовый и двоичный режимы.

val set_buffered : t -> bool -> unit

set_buffered oc true устанавливает канал oc в режим буферизации. В этом режиме вывод данных на oc будет буферизован до тех пор, пока внутренний буфер не заполнится или не будет вызвана функция Out_channel.flush или Out_channel.flush_all, в этот момент данные будут отправлены на устройство вывода.

set_buffered oc false устанавливает канал oc в режим небуферизованного вывода. В этом режиме вывод данных на oc будет отправлен на устройство вывода немедленно.

Все каналы по умолчанию открыты в режиме буферизации.

val is_buffered : t -> bool

is_buffered oc возвращает, является ли канал oc буферизованным (см. Out_channel.set_buffered).