package ppx_deriving

You can search for identifiers within the package.

in-package search v0.2.0

ppx_deriving.api
- Ppx_deriving
  - Arg
ppx_deriving.runtime
- Ppx_deriving_runtime
  - Array
  - Buffer
  - Bytes
  - Char
  - Format
  - Hashtbl
    
    HashedType
    
    Make
    
    H
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
  - Int32
  - Int64
  - LargeFile
  - Lazy
  - List
  - Map
    
    Make
    
    Ord
    
    OrderedType
    
    S
  - Nativeint
  - Pervasives
    
    LargeFile
  - Predef
  - Printexc
    
    Slot
  - Printf
  - Queue
  - Result
  - Set
    
    Make
    
    Ord
    
    OrderedType
    
    S
  - Stack
  - String
  - Weak
    
    Make
    
    H
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

First-in first-out queues.

This module implements queues (FIFOs), with in-place modification.

Warning This module is not thread-safe: each Queue.t value must be protected from concurrent access (e.g. with a Mutex.t). Failure to do so can lead to a crash.

exception Empty

Raised when Queue.take or Queue.peek is applied to an empty queue.

val create : unit -> 'a Queue.t

Return a new queue, initially empty.

val add : 'a -> 'a Queue.t -> unit

add x q adds the element x at the end of the queue q.

val push : 'a -> 'a Queue.t -> unit

push is a synonym for add.

val take : 'a Queue.t -> 'a

take q removes and returns the first element in queue q, or raises Empty if the queue is empty.

val pop : 'a Queue.t -> 'a

pop is a synonym for take.

val peek : 'a Queue.t -> 'a

peek q returns the first element in queue q, without removing it from the queue, or raises Empty if the queue is empty.

val top : 'a Queue.t -> 'a

top is a synonym for peek.

val clear : 'a Queue.t -> unit

Discard all elements from a queue.

val copy : 'a Queue.t -> 'a Queue.t

Return a copy of the given queue.

val is_empty : 'a Queue.t -> bool

Return true if the given queue is empty, false otherwise.

val length : 'a Queue.t -> int

Return the number of elements in a queue.

val iter : ('a -> unit) -> 'a Queue.t -> unit

iter f q applies f in turn to all elements of q, from the least recently entered to the most recently entered. The queue itself is unchanged.

val fold : ('b -> 'a -> 'b) -> 'b -> 'a Queue.t -> 'b

fold f accu q is equivalent to List.fold_left f accu l, where l is the list of q's elements. The queue remains unchanged.

val transfer : 'a Queue.t -> 'a Queue.t -> unit

transfer q1 q2 adds all of q1's elements at the end of the queue q2, then clears q1. It is equivalent to the sequence iter (fun x -> add x q2) q1; clear q1, but runs in constant time.