/usr/lib/ocaml/netclient/netftp_fs.mli is in libocamlnet-ocaml-dev 4.0.4-1build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 | (* $Id: netftp_fs.mli 2195 2015-01-01 12:23:39Z gerd $ *)
(** FTP filesystem *)
class type ftp_stream_fs =
object
inherit Netfs.stream_fs
method ftp_client : Netftp_client.ftp_client
(** The FTP client backing this filesystem *)
method last_ftp_state : Netftp_client.ftp_state
(** The last state of the last operation, or [Not_found] *)
method translate : string -> string
(** Translates a path into a URL *)
method close : unit -> unit
(** Forces that the FTP client is closed. (See [keep_open] option.)
The client remains functional - the next operation will re-open
the connection.
*)
end
class ftp_fs : ?config_client:(Netftp_client.ftp_client -> unit) ->
?tmp_directory:string ->
?tmp_prefix:string ->
?get_password:(string -> string) ->
?get_account:(string -> string) ->
?keep_open:bool ->
?tls_config:(module Netsys_crypto_types.TLS_CONFIG) ->
?tls_enabled:bool ->
?tls_required:bool ->
?gssapi_provider:(module Netsys_gssapi.GSSAPI) ->
?gssapi_config:Netsys_gssapi.client_config ->
?gssapi_required:bool ->
string -> ftp_stream_fs
(** [ftp_fs base_url]: Access the FTP file system rooted at [base_url].
The [base_url] must follow the [ftp://user\@host:port/path] scheme.
Passwords in [base_url] are ignored.
The following access methods are supported (compare with
{!Netfs.stream_fs}). Note that not all FTP servers can perform
all operations:
- [path_encoding]: If the FTP server announces that it uses UTF-8
as path encoding, this is returned here; else [None].
- [path_exclusions]: is just [0,0; 47,47]
- [nominal_dot_dot] is true. "." and ".." are resolved by the client
before sending paths to the server.
- [read]: is supported. Note that FTP distinguishes between text
and binary mode, so don't forget to pass the [`Binary] flag if needed.
The [`Skip] flag is only emulated - the full
file is retrieved first, and only the first bytes are hidden
from the user. There is no support for streaming mode; the
[`Streaming] flag is ignored. This means that the file is first
downloaded to a temporary file, and the returned object is just
a handle for this file.
- [write]: is supported, but - depending on the server - not all
flag combinations. The flag list [[`Create; `Truncate]] should
always work. For other flag lists, the server needs to support
the [MLST] command for checking whether the file already exists.
If this support is missing, an FTP error is raised. It is not
supported to omit both [`Create] and [`Truncate]. Also, the
[`Exclusive] flag is not supported. As for [read], there is no
streaming mode, and a temporary file is used as container.
- [size]: works only if the server supports the [SIZE] command
(otherwise ENOSYS).
- [test] and [test_list]: works only if the server supports the
[MLST] command (otherwise ENOSYS). The tests [`N], [`E], [`D], [`F],
[`S], [`R], [`W], and [`X] should work.
Files are never recognized as symlinks.
- [remove]: works, but the [`Recursive] flag is not supported
(and an emulation is considered as too dangerous)
- [readdir]: works
- [rename]: works
- [mkdir]: works, but the flags are ignored
- [rmdir]: works
There is no support for [symlink], [readlink], and [copy].
Options:
- [config_client]: one can enable further features on the client
object (e.g. proxies)
- [tmp_directory]: directory for temporary files
- [tmp_prefix]: file prefix for temporary files (w/o directory)
- [get_password]: This function should return the password for
the user (passed in as argument). Defaults to "".
- [get_account]: This function should return the account name for
the user (passed in as argument). Defaults to "".
- [keep_open]: By default, a new FTP connection is started for
each operation, and it is shut down afterward. By setting [keep_open]
the connection is kept open. The user has to call [close] when done.
- [tls_config]: The TLS configuration to use. (If not set, a
reasonable default is used.)
- [tls_enabled]: whether TLS is enabled
- [tls_required]: whether TLS is required
- [gssapi_provider]: The GSSAPI provider to use, e.g.
{!Netgss.System}. Note that there is no default, and GSSAPI remains
disabled if this option is not set.
- [gssapi_config]: the client configuration (with a reasonable default)
- [gssapi_required]: whether GSSAPI is required
*)
val ftp_fs : ?config_client:(Netftp_client.ftp_client -> unit) ->
?tmp_directory:string ->
?tmp_prefix:string ->
?get_password:(string -> string) ->
?get_account:(string -> string) ->
?keep_open:bool ->
?tls_config:(module Netsys_crypto_types.TLS_CONFIG) ->
?tls_enabled:bool ->
?tls_required:bool ->
?gssapi_provider:(module Netsys_gssapi.GSSAPI) ->
?gssapi_config:Netsys_gssapi.client_config ->
?gssapi_required:bool ->
string -> ftp_stream_fs
(** Same as function *)
|