File: actions.mli

package info (click to toggle)
libguestfs 1%3A1.54.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 98,888 kB
  • sloc: ansic: 379,443; ml: 38,771; sh: 10,328; java: 9,631; cs: 6,377; haskell: 5,729; makefile: 5,178; python: 3,821; perl: 2,467; erlang: 2,461; ruby: 349; xml: 275; pascal: 257; javascript: 157; cpp: 10
file content (62 lines) | stat: -rw-r--r-- 2,462 bytes parent folder | download | duplicates (2)
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
(* libguestfs
 * Copyright (C) 2009-2023 Red Hat Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *)

(* Please read generator/README first. *)

(** The libguestfs API. *)

val actions : Types.action list
(** The list of functions in the libguestfs API. *)

val daemon_functions : Types.action list -> Types.action list
val non_daemon_functions : Types.action list -> Types.action list
(** Filter {!actions}, returning only daemon function /
    non-daemon function respectively.

    The difference is that a daemon function is handled directly by
    the daemon.  A non-daemon function is implemented in the library side. *)

val external_functions : Types.action list -> Types.action list
(** Filter {!actions}, returning only external functions. *)

val internal_functions : Types.action list -> Types.action list
(** Filter {!actions}, returning only internal functions. *)

val fish_functions : Types.action list -> Types.action list
(** Filter {!actions}, returning only functions in guestfish. *)

val impl_ocaml_functions : Types.action list -> Types.action list
(** Filter {!actions}, returning only functions implemented
    in OCaml (in the daemon). *)

val documented_functions : Types.action list -> Types.action list
(** Filter {!actions}, returning only functions requiring documentation. *)

val sort : Types.action list -> Types.action list
(** Sort the functions alphabetically by name
    (see also {!Utils.action_compare}). *)

val find : string -> Types.action
(** Find an action by name.  If it doesn't exist, this fails with an
    error. *)

val is_documented : Types.action -> bool
(** Returns true if function should be documented, false otherwise. *)

val test_functions : Types.action list
(** Internal test functions used to test the language bindings. *)