package async_unix

  1. Overview
  2. Docs
package async_unix
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Scheduler = Raw_scheduler
module Unix = Unix_syscalls
module Id : sig ... end
module Read_result : sig ... end
module Internal : sig ... end
type nonrec t = Internal.t
val sexp_of_t : t -> Sexplib.Sexp.t
type nonrec 'a handle_chunk_result = 'a Internal.handle_chunk_result
val sexp_of_handle_chunk_result : 'a. ('a -> Sexplib.Sexp.t) -> 'a handle_chunk_result -> Sexplib.Sexp.t
type nonrec 'a handle_iobuf_result = 'a Internal.handle_iobuf_result
val sexp_of_handle_iobuf_result : 'a. ('a -> Sexplib.Sexp.t) -> 'a handle_iobuf_result -> Sexplib.Sexp.t
type nonrec 'a read_one_chunk_at_a_time_result = 'a Internal.read_one_chunk_at_a_time_result
val sexp_of_read_one_chunk_at_a_time_result : 'a. ('a -> Sexplib.Sexp.t) -> 'a read_one_chunk_at_a_time_result -> Sexplib.Sexp.t
type nonrec 'a read = 'a Internal.read
val close : Internal.t -> unit Async_kernel__.Types.Deferred.t
val close_finished : Internal.t -> unit Async_kernel__.Types.Deferred.t
val create : ?buf_len:Base.Int.t -> Fd.t -> Internal.t
val fd : Internal.t -> Fd.t
val id : Internal.t -> Id.t
val invariant : Internal.t -> unit
val io_stats : Io_stats.t
val is_closed : Internal.t -> bool
val last_read_time : Internal.t -> Core.Time.t
val of_in_channel : Core.In_channel.t -> Fd.Kind.t -> Internal.t
val open_file : ?buf_len:Base.Int.t -> string -> Internal.t Async_kernel__.Types.Deferred.t
val stdin : Internal.t lazy_t
val with_file : ?buf_len:Base.Int.t -> ?exclusive:bool -> string -> f:(Internal.t -> 'a Async_unix.Import.Monitor.Deferred.t) -> 'a Async_kernel__.Types.Deferred.t
val use : t -> unit
val finished_read : Internal.t -> unit
val do_read : t -> (unit -> 'a Async_kernel__.Types.Deferred.t) -> 'a Async_kernel__.Types.Deferred.t
val peek : t -> len:Base.Int.t -> [> `Eof | `Ok of Base.String.t ] Async_kernel__.Types.Deferred.t
val read : t -> ?pos:Base.Int.t -> ?len:Base.Int.t -> Core.Substring.base -> [> `Eof | `Ok of Core.Int.t ] Async_kernel__.Types.Deferred.t
val read_char : t -> [> `Eof | `Ok of Base.Char.t ] Async_kernel__.Types.Deferred.t
val read_substring : t -> Core.Substring.t -> [> `Eof | `Ok of Core.Int.t ] Async_kernel__.Types.Deferred.t
val read_bigsubstring : t -> Core.Bigsubstring.t -> [> `Eof | `Ok of Core.Int.t ] Async_kernel__.Types.Deferred.t
val read_one_chunk_at_a_time : t -> handle_chunk: (Core.Bigstring.t -> pos:int -> len:int -> [< `Consumed of int * [ `Need of Base.Int.t | `Need_unknown ] | `Continue | `Stop of 'a | `Stop_consumed of 'a * int ] Async_unix.Import.Deferred.t) -> [> `Eof | `Eof_with_unconsumed_data of Base.String.t | `Stopped of 'a ] Async_kernel__.Types.Deferred.t
val read_one_iobuf_at_a_time : t -> handle_chunk: (([< Core_kernel.Perms.Read_write.t ], Core.Iobuf.seek) Core.Iobuf.t -> [< `Continue | `Stop of 'a ] Async_kernel__.Types.Deferred.t) -> [> `Eof | `Eof_with_unconsumed_data of Base.String.t | `Stopped of 'a ] Async_kernel__.Types.Deferred.t
val really_read : t -> ?pos:Base.Int.t -> ?len:Base.Int.t -> Core.Substring.base -> [> `Eof of int | `Ok ] Async_kernel__.Types.Deferred.t
val really_read_substring : t -> Core.Substring.t -> [> `Eof of int | `Ok ] Async_kernel__.Types.Deferred.t
val really_read_bigsubstring : t -> Core.Bigsubstring.t -> [> `Eof of int | `Ok ] Async_kernel__.Types.Deferred.t
val read_line : t -> [> `Eof | `Ok of Base.String.t ] Async_kernel__.Types.Deferred.t
val really_read_line : wait_time:Core.Time.Span.t -> t -> Core.String.t option Async_kernel__.Types.Deferred.t
val do_read_k : t -> (('a Core.Or_error.t -> unit) -> unit) -> ('a -> 'b) -> 'b Async_unix.Import.Deferred.t
val read_until : t -> [< `Char of Base.Char.t | `Pred of Base.Char.t -> bool ] -> keep_delim:bool -> [> `Eof | `Eof_without_delim of Base.String.t | `Ok of Base.String.t ] Async_unix.Import.Deferred.t
val read_until_max : t -> [< `Char of Base.Char.t | `Pred of Base.Char.t -> bool ] -> keep_delim:bool -> max:int -> [> `Eof | `Eof_without_delim of Base.String.t | `Max_exceeded of Base.String.t | `Ok of Base.String.t ] Async_unix.Import.Deferred.t
val read_sexp : ?parse_pos:Core.Sexp.Parse_pos.t -> t -> [> `Eof | `Ok of Core.Sexp.t ] Async_unix.Import.Deferred.t
val peek_or_read_bin_prot : ?max_len:int -> t -> 'a Core.Bin_prot.Type_class.reader -> peek_or_read:Internal.Peek_or_read.t -> [> `Eof | `Ok of 'a ] Async_unix.Import.Deferred.t
val peek_bin_prot : ?max_len:int -> t -> 'a Core.Bin_prot.Type_class.reader -> [> `Eof | `Ok of 'a ] Async_unix.Import.Deferred.t
val read_bin_prot : ?max_len:int -> t -> 'a Core.Bin_prot.Type_class.reader -> [> `Eof | `Ok of 'a ] Async_unix.Import.Deferred.t
val read_marshal_raw : t -> [> `Eof | `Ok of Core.String.t ] Async_kernel__.Types.Deferred.t
val read_marshal : t -> [> `Eof | `Ok of 'a ] Async_kernel__.Types.Deferred.t
val recv : t -> [> `Eof | `Ok of Core.String.t ] Async_kernel__.Types.Deferred.t
val read_all : Internal.t -> (Internal.t -> [< `Eof | `Ok of 'a ] Async_kernel__.Types.Deferred.t) -> 'a Async_unix.Import.Pipe.Reader.t
val contents : t -> string Async_kernel__.Types.Deferred.t
val file_contents : string -> string Async_kernel__.Types.Deferred.t
val file_lines : string -> Base.String.t list Async_kernel__.Types.Deferred.t
val lseek : t -> int64 -> mode:[< `Cur | `End | `Set ] -> int64 Async_kernel__.Types.Deferred.t
val ltell : t -> Core.Int64.t Async_kernel__.Types.Deferred.t
val get_error : file:Base.String.t -> sexp_kind:'a Internal.sexp_kind -> a_of_sexp:('a -> 'b) -> Core.Sexp.Annotated.t -> (unit, Core_kernel.Error.t) Core._result
val gen_load_exn : ?exclusive:bool -> sexp_kind:'a Internal.sexp_kind -> file:Base.String.t -> ('a list -> 'b) -> (Core.Sexp.Annotated.t list -> Core.Error.t) -> 'b Async_unix.Import.Deferred.t
type ('sexp, 'a, 'b) load = ?exclusive:bool -> ?expand_macros:bool -> string -> ('sexp -> 'a) -> 'b Async_unix.Import.Deferred.t
module Macro_loader : sig ... end
val get_load_result_exn : [< `Error of exn * 'a | `Result of 'b ] -> 'b
val gen_load_sexp_exn : ?exclusive:bool -> ?expand_macros:bool -> sexp_kind:'a Internal.sexp_kind -> file:Base.String.t -> a_of_sexp:('a -> 'b) -> 'b Async_kernel__.Types.Deferred.t
val load_sexp_exn : ?exclusive:bool -> ?expand_macros:bool -> Base.String.t -> (Core.Sexp.t -> 'a) -> 'a Async_kernel__.Types.Deferred.t
val load_annotated_sexp_exn : ?exclusive:bool -> ?expand_macros:bool -> Base.String.t -> (Core.Sexp.Annotated.t -> 'a) -> 'a Async_kernel__.Types.Deferred.t
val gen_load_sexp : ?exclusive:bool -> ?expand_macros:bool -> sexp_kind:'a Internal.sexp_kind -> file:Base.String.t -> a_of_sexp:('a -> 'b) -> 'b Async_unix.Import.Deferred.Or_error.t
val load_sexp : ?exclusive:bool -> ?expand_macros:bool -> Base.String.t -> (Core.Sexp.t -> 'a) -> 'a Async_unix.Import.Deferred.Or_error.t
val load_annotated_sexp : ?exclusive:bool -> ?expand_macros:bool -> Base.String.t -> (Core.Sexp.Annotated.t -> 'a) -> 'a Async_unix.Import.Deferred.Or_error.t
val gen_load_sexps_exn : ?exclusive:bool -> ?expand_macros:bool -> sexp_kind:'a Internal.sexp_kind -> file:Base.String.t -> a_of_sexp:('a -> 'b) -> 'b Core.List.t Async_kernel__.Types.Deferred.t
val load_sexps_exn : ?exclusive:bool -> ?expand_macros:bool -> Base.String.t -> (Core.Sexp.t -> 'a) -> 'a Core.List.t Async_kernel__.Types.Deferred.t
val load_annotated_sexps_exn : ?exclusive:bool -> ?expand_macros:bool -> Base.String.t -> (Core.Sexp.Annotated.t -> 'a) -> 'a Core.List.t Async_kernel__.Types.Deferred.t
val gen_load_sexps : ?exclusive:bool -> ?expand_macros:bool -> sexp_kind:'a Internal.sexp_kind -> file:Base.String.t -> a_of_sexp:('a -> 'b) -> 'b Core.List.t Async_unix.Import.Deferred.Or_error.t
val load_sexps : ?exclusive:bool -> ?expand_macros:bool -> Base.String.t -> (Core.Sexp.t -> 'a) -> 'a Core.List.t Async_unix.Import.Deferred.Or_error.t
val load_annotated_sexps : ?exclusive:bool -> ?expand_macros:bool -> Base.String.t -> (Core.Sexp.Annotated.t -> 'a) -> 'a Core.List.t Async_unix.Import.Deferred.Or_error.t
val drain : t -> unit Async_kernel__.Types.Deferred.t
type ('a, 'b) load_bin_prot = ?exclusive:bool -> ?max_len:int -> string -> 'a Core.Bin_prot.Type_class.reader -> 'b Async_unix.Import.Deferred.t
val load_bin_prot : ?exclusive:bool -> ?max_len:int -> string -> 'a Core.Bin_prot.Type_class.reader -> ('a, Core_kernel.Error.t) Core._result Async_kernel__.Types.Deferred.t
val load_bin_prot_exn : ?exclusive:bool -> ?max_len:int -> string -> 'a Core.Bin_prot.Type_class.reader -> 'a Async_kernel__.Types.Deferred.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct