mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
documentation
This commit is contained in:
parent
1a2ffbb262
commit
6a79b88ef0
3 changed files with 18 additions and 3 deletions
|
|
@ -68,6 +68,7 @@ CCBV
|
|||
CCCache
|
||||
CCFQueue
|
||||
CCFlatHashtbl
|
||||
CCMixmap
|
||||
CCMixtbl
|
||||
CCMultiMap
|
||||
CCMultiSet
|
||||
|
|
@ -131,6 +132,16 @@ UnionFind
|
|||
Univ
|
||||
}
|
||||
|
||||
{4 Lwt}
|
||||
|
||||
Utils for Lwt (including experimental stuff)
|
||||
|
||||
{!modules:
|
||||
Lwt_actor
|
||||
Lwt_klist
|
||||
Lwt_pipe
|
||||
}
|
||||
|
||||
{4 Others}
|
||||
|
||||
{!modules:
|
||||
|
|
|
|||
|
|
@ -82,8 +82,8 @@ val set : inj:'b injection -> 'a t -> 'a -> 'b -> unit
|
|||
|
||||
val find : inj:'b injection -> 'a t -> 'a -> 'b
|
||||
(** Find the value for the given key, which must be of the right type.
|
||||
raises Not_found if either the key is not found, or if its value
|
||||
doesn't belong to the right type *)
|
||||
@raise Not_found if either the key is not found, or if its value
|
||||
doesn't belong to the right type *)
|
||||
|
||||
val length : 'a t -> int
|
||||
(** Number of bindings *)
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|||
|
||||
Stream processing using:
|
||||
|
||||
- Pipe: a possibly buffered channel through which readers and writer communicate
|
||||
- Pipe: a possibly buffered channel that can act as a reader or as a writer
|
||||
- Reader: accepts values, produces effects
|
||||
- Writer: yield values
|
||||
|
||||
|
|
@ -115,6 +115,8 @@ val write_list : ('a, [>`w]) t -> 'a list -> unit Lwt.t
|
|||
val write_error : (_, [>`w]) t -> string -> unit Lwt.t
|
||||
(** @raise Pipe.Closed if the writer is closed *)
|
||||
|
||||
(** {2 Write-only Interface and Combinators} *)
|
||||
|
||||
module Writer : sig
|
||||
type 'a t = ('a, [`w]) pipe
|
||||
|
||||
|
|
@ -131,6 +133,8 @@ module Writer : sig
|
|||
@raise Invalid_argument if the list is empty *)
|
||||
end
|
||||
|
||||
(** {2 Read-only Interface and Combinators} *)
|
||||
|
||||
module Reader : sig
|
||||
type 'a t = ('a, [`r]) pipe
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue