Module `Iobuf_unix`Source

module Unix := Core_unix

Sourcetype ok_or_eof =

| Ok
| Eof

Sourceval compare_ok_or_eof : ok_or_eof -> ok_or_eof -> int

Sourceval sexp_of_ok_or_eof : ok_or_eof -> Sexplib0.Sexp.t

val input : 
  ([> Core.write ], Iobuf.seek) Iobuf.t ->
  Core.In_channel.t ->
  ok_or_eof

Iobuf has analogs of various Bigstring functions. These analogs advance by the amount written/read.

Source

val read : 
  ([> Core.write ], Iobuf.seek) Iobuf.t ->
  Unix.File_descr.t ->
  ok_or_eof

Source

val read_assume_fd_is_nonblocking : 
  ([> Core.write ], Iobuf.seek) Iobuf.t ->
  Unix.File_descr.t ->
  Unix.Syscall_result.Unit.t

Source

val pread_assume_fd_is_nonblocking : 
  ([> Core.write ], Iobuf.seek) Iobuf.t ->
  Unix.File_descr.t ->
  offset:int ->
  unit

Source

val recvfrom_assume_fd_is_nonblocking : 
  ([> Core.write ], Iobuf.seek) Iobuf.t ->
  Unix.File_descr.t ->
  Unix.sockaddr

Sourcemodule Recvmmsg_context : sig ... end

recvmmsg's context comprises data needed by the system call. Setup can be expensive, particularly for many buffers.

Source

val recvmmsg_assume_fd_is_nonblocking : 
  (Unix.File_descr.t ->
    Recvmmsg_context.t ->
    Unix.Syscall_result.Int.t)
    Core.Or_error.t

recvmmsg_assume_fd_is_nonblocking fd context returns the number of context iobufs read into (or errno). fd must not block. THREAD_IO_CUTOFF is ignored.

EINVAL is returned if an Iobuf passed to Recvmmsg_context.create has its buf or limits changed.

Source

val send_nonblocking_no_sigpipe : 
  unit ->
  (([> Core.read ], Iobuf.seek) Iobuf.t ->
    Unix.File_descr.t ->
    Unix.Syscall_result.Unit.t)
    Core.Or_error.t

Source

val sendto_nonblocking_no_sigpipe : 
  unit ->
  (([> Core.read ], Iobuf.seek) Iobuf.t ->
    Unix.File_descr.t ->
    Unix.sockaddr ->
    Unix.Syscall_result.Unit.t)
    Core.Or_error.t

Sourcemodule Peek : sig ... end

Write from the iobuf to the specified channel without changing the iobuf window. Returns the number of bytes written.

Sourceval output : ([> Core.read ], Iobuf.seek) Iobuf.t -> Core.Out_channel.t -> unit

As Peek, but advances the window by the number of bytes written.

Sourceval write : ([> Core.read ], Iobuf.seek) Iobuf.t -> Unix.File_descr.t -> unit

Source

val write_assume_fd_is_nonblocking : 
  ([> Core.read ], Iobuf.seek) Iobuf.t ->
  Unix.File_descr.t ->
  unit

Source

val pwrite_assume_fd_is_nonblocking : 
  ([> Core.read ], Iobuf.seek) Iobuf.t ->
  Unix.File_descr.t ->
  offset:int ->
  unit

Sourcemodule In_channel_optimized : sig ... end

As similar APIs in In_channel, but using an intermediate Iobuf; considerably faster.

Expert

Sourcemodule Expert : sig ... end

The Expert module is for building efficient out-of-module Iobuf abstractions.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/core_unix.iobuf_unix/Iobuf_unix/index.html

Module `Iobuf_unix`Source

Expert

package core_unix

Install

Dune Dependency

Authors

Maintainers

Sources

doc/core_unix.iobuf_unix/Iobuf_unix/index.html

Module Iobuf_unixSource

Expert

Module `Iobuf_unix`Source