File: guestfs-ocaml.pod

package info (click to toggle)
libguestfs 1%3A1.40.2-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 123,660 kB
  • sloc: ansic: 460,074; ml: 63,059; sh: 14,955; java: 9,512; makefile: 9,133; cs: 6,300; haskell: 5,652; python: 3,856; perl: 3,619; erlang: 2,435; xml: 1,683; ruby: 350; pascal: 255; lex: 135; yacc: 128; cpp: 10
file content (96 lines) | stat: -rw-r--r-- 2,591 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
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

=head1 名前

guestfs-ocaml - OCaml から libguestfs を使用する方法

=head1 書式

モジュール形式:

 let g = Guestfs.create () in
 Guestfs.add_drive_opts g ~format:"raw" ~readonly:true "disk.img";
 Guestfs.launch g;

オブジェクト指向スタイル:

 let g = new Guestfs.guestfs () in
 g#add_drive_opts ~format:"raw" ~readonly:true "disk.img";
 g#launch ();

 ocamlfind opt prog.ml -package guestfs -linkpkg -o prog
or:
 ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog

=head1 説明

This manual page documents how to call libguestfs from the OCaml programming
language.  This page just documents the differences from the C API and gives
some examples.  If you are not familiar with using libguestfs, you also need
to read L<guestfs(3)>.

=head2 プログラミング形式

There are two different programming styles supported by the OCaml bindings.
You can use a module style, with each C function mapped to an OCaml
function:

 int guestfs_set_verbose (guestfs_h *g, int flag);

becomes:

 val Guestfs.set_verbose : Guestfs.t -> bool -> unit

Alternately you can use an object-oriented style, calling methods on the
class C<Guestfs.guestfs>:

 method set_verbose : bool -> unit

The object-oriented style is usually briefer, and the minor performance
penalty isn't noticeable in the general overhead of performing libguestfs
functions.

=head2 ハンドルの閉じ方

The handle is closed when it is reaped by the garbage collector.  Because
libguestfs handles include a lot of state, it is also possible to close (and
hence free) them explicitly by calling C<Guestfs.close> or the C<#close>
method.

=head2 例外

Errors from libguestfs functions are mapped into the C<Guestfs.Error>
exception.  This has a single parameter which is the error message (a
string).

Calling any function/method on a closed handle raises
C<Guestfs.Handle_closed>.  The single parameter is the name of the function
that you called.

=head1 例: ディスクイメージの作成

@CREATE_DISK@

=head1 例: 仮想マシンのディスクイメージの検査

@INSPECT_VM@

=head1 例: デバッグおよびロギングの有効化

@DEBUG_LOGGING@

=head1 関連項目

L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>,
L<guestfs-gobject(3)>, L<guestfs-golang(3)>, L<guestfs-java(3)>,
L<guestfs-lua(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>,
L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>,
L<http://caml.inria.fr/>.

=head1 著者

Richard W.M. Jones (C<rjones at redhat dot com>)

=head1 COPYRIGHT

Copyright (C) 2010-2012 Red Hat Inc.