package mindstorm-lwt

  1. Overview
  2. Docs

Module NXT.FindSource

List files on the brick matching a given pattern.

Sourcetype 'a iterator

An iterator to allow to enumerate files on the brick.

Sourceval patt : 'a conn -> string -> 'a iterator Lwt.t

Find.patt conn fpatt returns an iterator listing the filenames mathing the pattern fpatt. The following types of wildcards are accepted:

  • filename.extension
  • *.[file type name]
  • filename.*
  • *.*
Sourceval current : 'a iterator -> string Lwt.t

Find.current i returns the current filename.

Sourceval current_size : 'a iterator -> int Lwt.t

Find.current_size i returns the current filename size (number of bytes).

Sourceval next : 'a iterator -> unit Lwt.t

Execute a new request to the brick to retrieve the next filename matching the pattern.

  • raises File_not_found

    if no more file was found. When this exception is raised, the iterator is closed.

Sourceval close : 'a iterator -> unit Lwt.t

close_iterator i closes the iterator i. Closing an already closed iterator does nothing.

Sourceval iter : 'a conn -> f:(string -> int -> unit Lwt.t) -> string -> unit Lwt.t

iter f fpatt iterates f name size on all the filenames matching the pattern fpatt (see Mindstorm_lwt.NXT.Find.patt for the accepted patterns).

Sourceval map : 'a conn -> f:(string -> int -> 'b Lwt.t) -> string -> 'b list Lwt.t

map f fpatt maps f name size on all the filenames matching the pattern fpatt and return the list formed of those. (See Mindstorm_lwt.NXT.Find.patt for the accepted patterns.)

Sourceval fold : 'a conn -> f:(string -> int -> 'b -> 'b Lwt.t) -> string -> 'b -> 'b Lwt.t

fold f fpatt a0 folds f on all the filenames matching the pattern fpatt (see Mindstorm_lwt.NXT.Find.patt for the accepted patterns).