package async_find

You can search for identifiers within the package.

in-package search v0.2.0

Directory traversal with Async

Install

Dune Dependency

github.com Changelog MIT License Edit opam file Versions (6)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

async_find-v0.13.0.tar.gz

sha256=e848ee6c974e5496c9c59a3e0c87773e0fa31e7bad635ac7feab3a911ef7f2de

md5=cfef781aeedf8ddbf2a7a02cda817c0a

doc/async_find/Async_find/index.html

Module `Async_find`

type t

module Options : sig ... end

val create : ?options:Options.t -> string -> t

create ?options dir create a Find.t based in dir

val next : t -> (string * Async.Unix.Stats.t) option Async.Deferred.t

next t return the next file from the collection of valid files in t or None if no more files remain

val close : t -> unit Async.Deferred.t

close t drops all the resources associated with t. Attempting to use t again will raise an exception. Any Find.t will be automatically closed after the last file is read by any means.

val iter : 
  t ->
  f:((string * Async.Unix.Stats.t) -> unit Async.Deferred.t) ->
  unit Async.Deferred.t

iter t ~f calls f on every file in t

val fold : 
  t ->
  init:'a ->
  f:('a -> (string * Async.Unix.Stats.t) -> 'a Async.Deferred.t) ->
  'a Async.Deferred.t

fold t ~init ~f folds f over the files in t

val to_list : t -> (string * Async.Unix.Stats.t) list Async.Deferred.t

to_list t returns all of the remaining files in t as a list in the order they would have been returned by subsequent calls to next

val find_all : 
  ?options:Options.t ->
  string ->
  (string * Async.Unix.Stats.t) list Async.Deferred.t

find_all ?options dir short for to_list (create ?options dir)