package async_unix

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Finding elements
Adding, removing, and replacing elements
Iterating over elements

package async_unix

async_unix
- Async_unix
  - Async_config
  - Clock
    
    Event
    
    Status
  - Dump_core_on_job_delay
    
    How_to_dump
  - Fd
    
    Close
    
    Kind
  - In_thread
    
    Helper_thread
    
    Priority
  - Io_stats
  - LargeFile
  - Log
    
    Blocking
    
    Output
    
    For_testing
    
    Global
    
    Global_intf
    
    Level
    
    Stable
    
    V1
    
    Make_global
    
    Message
    
    Stable
    
    V0
    
    V2
    
    Output
    
    Format
    
    Stable
    
    V1
    
    Reader
    
    Expert
    
    Rotation
    
    Id_intf
  - Overwrite_
  - Print
  - Printf
  - Process
    
    Lines_or_sexp
    
    Output
    
    Stable
    
    V1
  - Reader
    
    Id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Tree
    
    Provide_of_sexp
    
    K
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Tree
    
    Named
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Read_result
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
  - Require_explicit_time_source
    
    Clock
    
    Event
    
    Status
    
    Scheduler
    
    Time
    
    Time_ns
  - Scheduler
    
    Expert
  - Sexp
  - Shutdown
  - Signal
  - Socket
    
    Address
    
    Blocking_sexp
    
    Inet
    
    Blocking_sexp
    
    Show_port_in_test
    
    Unix
    
    Family
    
    Opt
    
    Type
  - Sys
  - Thread_safe
  - Unix
    
    Addr_info
    
    Blocking_sexp
    
    File_kind
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Tree
    
    Provide_of_sexp
    
    K
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Tree
    
    Named
    
    Provide_of_sexp
    
    Elt
    
    Group
    
    Fields
    
    Direct
    
    Host
    
    Inet_addr
    
    Name_info
    
    Passwd
    
    Fields
    
    Direct
    
    Private
    
    Wait
    
    Protocol_family
    
    Socket
    
    Address
    
    Blocking_sexp
    
    Inet
    
    Blocking_sexp
    
    Show_port_in_test
    
    Unix
    
    Family
    
    Opt
    
    Type
    
    Stats
    
    Fields
    
    Direct
    
    Terminal_io
  - Writer
    
    Backing_out_channel
    
    Destroy_or_keep
    
    Id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Tree
    
    Provide_of_sexp
    
    K
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Tree
    
    Named
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Line_ending
    
    Terminate_with
async_unix.thread_pool
- Thread_pool
  - Helper_thread
  - Priority
async_unix.thread_safe_ivar
- Thread_safe_ivar
async_unix.thread_safe_pipe
- Thread_safe_pipe
  - If_closed
  - Written_or_closed

Legend:
Library
Module
Module type
Parameter
Class
Class type

module Key : sig ... end

type 'a t

A hash-queue, where the values are of type 'a.

val sexp_of_t : 
  ('a -> Ppx_sexp_conv_lib.Sexp.t) ->
  'a t ->
  Ppx_sexp_conv_lib.Sexp.t

val length : 'a t -> int

val is_empty : 'a t -> bool

val iter : 'a t -> f:('a -> unit) -> unit

val fold : 'a t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum

val fold_result : 
  'a t ->
  init:'accum ->
  f:('accum -> 'a -> ('accum, 'e) Base__.Result.t) ->
  ('accum, 'e) Base__.Result.t

val fold_until : 
  'a t ->
  init:'accum ->
  f:('accum -> 'a -> ('accum, 'final) Base__.Container_intf.Continue_or_stop.t) ->
  finish:('accum -> 'final) ->
  'final

val exists : 'a t -> f:('a -> bool) -> bool

val for_all : 'a t -> f:('a -> bool) -> bool

val count : 'a t -> f:('a -> bool) -> int

val sum : 
  (module Base__.Container_intf.Summable with type t = 'sum) ->
  'a t ->
  f:('a -> 'sum) ->
  'sum

val find : 'a t -> f:('a -> bool) -> 'a option

val find_map : 'a t -> f:('a -> 'b option) -> 'b option

val to_list : 'a t -> 'a list

val to_array : 'a t -> 'a array

val min_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option

val max_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option

invariant t checks the invariants of the queue.

val invariant : 'a t -> Base.Unit.t

val create : 
  ?growth_allowed:Base.Bool.t ->
  ?size:Base.Int.t ->
  Base.Unit.t ->
  'a t

create () returns an empty queue. The arguments growth_allowed and size are referring to the underlying hashtable.

parameter growth_allowed
defaults to true

parameter size
initial size -- default to 16

val clear : 'a t -> Base.Unit.t

Clears the queue.

Finding elements

val mem : 'a t -> Key.t -> Base.Bool.t

mem q k returns true iff there is some (k, v) in the queue.

val lookup : 'a t -> Key.t -> 'a Base.Option.t

lookup t k returns the value of the key-value pair in the queue with key k, if there is one.

val lookup_exn : 'a t -> Key.t -> 'a

Adding, removing, and replacing elements

Note that even the non-*_exn versions can raise, but only if there is an ongoing iteration.

val enqueue : 
  'a t ->
  [ `back | `front ] ->
  Key.t ->
  'a ->
  [ `Ok | `Key_already_present ]

enqueue t back_or_front k v adds the key-value pair (k, v) to the front or back of the queue, returning `Ok if the pair was added, or `Key_already_present if there is already a (k, v') in the queue.

val enqueue_exn : 'a t -> [ `back | `front ] -> Key.t -> 'a -> Base.Unit.t

Like enqueue, but it raises in the `Key_already_present case

val enqueue_back : 'a t -> Key.t -> 'a -> [ `Ok | `Key_already_present ]

See enqueue. enqueue_back t k v is the same as enqueue t `back k v

val enqueue_back_exn : 'a t -> Key.t -> 'a -> Base.Unit.t

See enqueue_exn. enqueue_back_exn t k v is the same as enqueue_exn t `back k v

val enqueue_front : 'a t -> Key.t -> 'a -> [ `Ok | `Key_already_present ]

See enqueue. enqueue_front t k v is the same as enqueue t `front k v

val enqueue_front_exn : 'a t -> Key.t -> 'a -> Base.Unit.t

See enqueue_exn. enqueue_front_exn t k v is the same as enqueue_exn t `front k v

val lookup_and_move_to_back : 'a t -> Key.t -> 'a Base.Option.t

lookup_and_move_to_back finds the key-value pair (k, v) and moves it to the back of the queue if it exists, otherwise returning None.

The _exn versions of these functions raise if key-value pair does not exist.

val lookup_and_move_to_back_exn : 'a t -> Key.t -> 'a

Like lookup_and_move_to_back, but raises instead of returning an option

val lookup_and_move_to_front : 'a t -> Key.t -> 'a Base.Option.t

Like lookup_and_move_to_back, but moves element to the front of the queue

val lookup_and_move_to_front_exn : 'a t -> Key.t -> 'a

Like lookup_and_move_to_front, but raises instead of returning an option

val first : 'a t -> 'a Base.Option.t

first t returns the front element of the queue, without removing it.

val first_with_key : 'a t -> (Key.t * 'a) Base.Option.t

first_with_key t returns the front element of the queue and its key, without removing it.

val keys : 'a t -> Key.t Base.List.t

keys t returns the keys in the order of the queue.

val dequeue : 'a t -> [ `back | `front ] -> 'a Base.Option.t

dequeue t front_or_back returns the front or back element of the queue.

val dequeue_exn : 'a t -> [ `back | `front ] -> 'a

Like dequeue, but it raises if the queue is empty.

val dequeue_back : 'a t -> 'a Base.Option.t

dequeue_back t returns the back element of the queue.

val dequeue_back_exn : 'a t -> 'a

Like dequeue_back, but it raises if the queue is empty.

val dequeue_front : 'a t -> 'a Base.Option.t

dequeue_front t returns the front element of the queue.

val dequeue_front_exn : 'a t -> 'a

Like dequeue_front, but it raises if the queue is empty.

val dequeue_with_key : 'a t -> [ `back | `front ] -> (Key.t * 'a) Base.Option.t

dequeue_with_key t returns the front or back element of the queue and its key.

val dequeue_with_key_exn : 'a t -> [ `back | `front ] -> Key.t * 'a

Like dequeue_with_key, but it raises if the queue is empty.

val dequeue_back_with_key : 'a t -> (Key.t * 'a) Base.Option.t

dequeue_back_with_key t returns the back element of the queue and its key.

val dequeue_back_with_key_exn : 'a t -> Key.t * 'a

Like dequeue_back_with_key, but it raises if the queue is empty.

val dequeue_front_with_key : 'a t -> (Key.t * 'a) Base.Option.t

dequeue_front_with_key t returns the front element of the queue and its key.

val dequeue_front_with_key_exn : 'a t -> Key.t * 'a

Like dequeue_front_with_key, but it raises if the queue is empty.

val dequeue_all : 'a t -> f:('a -> Base.Unit.t) -> Base.Unit.t

dequeue_all t ~f dequeues every element of the queue and applies f to each one. The dequeue order is from front to back.

val remove : 'a t -> Key.t -> [ `Ok | `No_such_key ]

remove q k removes the key-value pair with key k from the queue.

val remove_exn : 'a t -> Key.t -> Base.Unit.t

val replace : 'a t -> Key.t -> 'a -> [ `Ok | `No_such_key ]

replace q k v changes the value of key k in the queue to v.

val replace_exn : 'a t -> Key.t -> 'a -> Base.Unit.t

val drop : ?n:Base.Int.t -> 'a t -> [ `back | `front ] -> Base.Unit.t

drop ?n q back_or_front drops n elements (default 1) from the back or front of the queue. If the queue has fewer than n elements then it is cleared.

val drop_front : ?n:Base.Int.t -> 'a t -> Base.Unit.t

Equivalent to drop ?n q `front.

val drop_back : ?n:Base.Int.t -> 'a t -> Base.Unit.t

Equivalent to drop ?n q `back.

Iterating over elements

val iteri : 'a t -> f:(key:Key.t -> data:'a -> Base.Unit.t) -> Base.Unit.t

iter t ~f applies f to each key and element of the queue.

val foldi : 'a t -> init:'b -> f:('b -> key:Key.t -> data:'a -> 'b) -> 'b