Iobuf_unix (core_unix.core_unix.iobuf_unix.Iobuf

module Unix := Core_unix

type ok_or_eof =

| Ok
| Eof

val compare_ok_or_eof : ok_or_eof -> ok_or_eof -> int

val compare_ok_or_eof__local : 
  ok_or_eof @ local ->
  (ok_or_eof @ local ->
  int) @ local

val sexp_of_ok_or_eof : ok_or_eof -> Sexplib0.Sexp.t

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

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

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

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

val really_pread : 
  ([> Core.write ], Iobuf.seek, Iobuf.global) Iobuf.t ->
  Unix.File_descr.t ->
  offset:int ->
  ok_or_eof

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

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

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

module Recvmmsg_context : sig ... end

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

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.

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

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

module Peek : sig ... end

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

val output : 
  ([> Core.read ], Iobuf.seek, Iobuf.global) Iobuf.t @ local ->
  (Core.Out_channel.t ->
  unit) @ local

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

val write : 
  ([> Core.read ], Iobuf.seek, Iobuf.global) Iobuf.t @ local ->
  (Unix.File_descr.t ->
  unit) @ local

val really_write : 
  ([> Core.read ], Iobuf.seek, Iobuf.global) Iobuf.t @ local ->
  (Unix.File_descr.t ->
  unit) @ local

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

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

Expert

module Expert : sig ... end

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