- changes defaults of getxml (format gzipped, don't patch dtd)

[helm.git] / helm / ocaml / getter / http_getter_misc.mli

diff --git a/helm/ocaml/getter/http_getter_misc.mli b/helm/ocaml/getter/http_getter_misc.mli
index b328742be76370b1ca804a3c06510999406327d6..bc2f72a3198bd52db7c9bfb754a6ab2905199de1 100644 (file)
--- a/helm/ocaml/getter/http_getter_misc.mli
+++ b/helm/ocaml/getter/http_getter_misc.mli
@@ -30,13 +30,24 @@
  failure reason *)
 exception Mkdir_failure of string * string
 
+  (** @return Some localpart for URI belonging to the "file://" scheme, None for
+  * other URIs
+  * removes trailing ".gz", if any
+  * e.g.: local_url "file:///etc/passwd.gz" = Some "/etc/passwd"
+  *       local_url "http://...." = None *)
+val local_url: string -> string option
+
  (** "fold_left" like function on file lines, trailing newline is not passed to
  the given function *)
 val fold_file : (string -> 'a -> 'a) -> 'a -> string -> 'a
+
  (* "iter" like function on file lines, trailing newline is not passed to the
  given function *)
 val iter_file : (string -> unit) -> string -> unit
 
+ (* "iter" like function on file data chunks of fixed size *)
+val iter_file_data: (string -> unit) -> string -> unit
+
   (** like Hashtbl.fold but keys are processed ordered *)
 val hashtbl_sorted_fold :
   ('a -> 'b -> 'c -> 'c) -> ('a, 'b) Hashtbl.t -> 'c -> 'c
@@ -67,13 +78,10 @@ val mkdir: ?parents: bool -> string -> unit
   (** pretty printer for Unix.process_status values *)
 val string_of_proc_status : Unix.process_status -> string
 
-  (** raw HTTP downloader, return Some the contents of downloaded resource or
+  (** raw URL downloader, return Some the contents of downloaded resource or
   None if an error occured while downloading. This function support also
   "file://" scheme for filesystem resources *)
 val http_get: string -> string option
-  (** 'iter' like method that iter over string slices (unspecified length) of a
-  remote resources fetched via HTTP GET requests *)
-val http_get_iter_buf: callback:(string -> unit) -> string -> unit
 
   (** true on blanks-only and #-commented lines, false otherwise *)
 val is_blank_line: string -> bool