<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Libvirt.Pool.html">
<link rel="next" href="Libvirt.Virterror.html">
<link rel="Up" href="Libvirt.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Libvirt" rel="Chapter" href="Libvirt.html">
<link title="Libvirt_version" rel="Chapter" href="Libvirt_version.html"><title>Libvirt.Volume</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Libvirt.Pool.html" title="Libvirt.Pool">Previous</a>
<a class="up" href="Libvirt.html" title="Libvirt">Up</a>
<a class="post" href="Libvirt.Virterror.html" title="Libvirt.Virterror">Next</a>
</div>
<h1>Module <a href="type_Libvirt.Volume.html">Libvirt.Volume</a></h1>
<pre><span class="keyword">module</span> Volume: <code class="code">sig</code> <a href="Libvirt.Volume.html">..</a> <code class="code">end</code></pre><div class="info">
Module dealing with storage volumes.<br>
</div>
<hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'rw</code> t</span> </pre>
<div class="info">
Storage volume handle.<br>
</div>
<pre><code><span id="TYPEvol_type"><span class="keyword">type</span> <code class="type"></code>vol_type</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvol_type.File"><span class="constructor">File</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvol_type.Block"><span class="constructor">Block</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Type of a storage volume.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<pre><code><span id="TYPEvol_delete_flags"><span class="keyword">type</span> <code class="type"></code>vol_delete_flags</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvol_delete_flags.Normal"><span class="constructor">Normal</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvol_delete_flags.Zeroed"><span class="constructor">Zeroed</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Flags for deleting a storage volume.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<pre><code><span id="TYPEvol_info"><span class="keyword">type</span> <code class="type"></code>vol_info</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvol_info.typ">typ</span> :<code class="type"><a href="Libvirt.Volume.html#TYPEvol_type">vol_type</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Type of storage volume.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvol_info.capacity">capacity</span> :<code class="type">int64</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Logical size in bytes.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvol_info.allocation">allocation</span> :<code class="type">int64</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Currently allocated in bytes.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<pre><span id="VALlookup_by_name"><span class="keyword">val</span> lookup_by_name</span> : <code class="type">'a <a href="Libvirt.Pool.html#TYPEt">Libvirt.Pool.t</a> -> string -> 'a <a href="Libvirt.Volume.html#TYPEt">t</a></code></pre><pre><span id="VALlookup_by_key"><span class="keyword">val</span> lookup_by_key</span> : <code class="type">'a <a href="Libvirt.Connect.html#TYPEt">Libvirt.Connect.t</a> -> string -> 'a <a href="Libvirt.Volume.html#TYPEt">t</a></code></pre><pre><span id="VALlookup_by_path"><span class="keyword">val</span> lookup_by_path</span> : <code class="type">'a <a href="Libvirt.Connect.html#TYPEt">Libvirt.Connect.t</a> -> string -> 'a <a href="Libvirt.Volume.html#TYPEt">t</a></code></pre><div class="info">
Look up a storage volume by name, key or path volume.<br>
</div>
<pre><span id="VALpool_of_volume"><span class="keyword">val</span> pool_of_volume</span> : <code class="type">'a <a href="Libvirt.Volume.html#TYPEt">t</a> -> 'a <a href="Libvirt.Pool.html#TYPEt">Libvirt.Pool.t</a></code></pre><div class="info">
Get the storage pool containing this volume.<br>
</div>
<pre><span id="VALget_name"><span class="keyword">val</span> get_name</span> : <code class="type">[ `R ] <a href="Libvirt.Volume.html#TYPEt">t</a> -> string</code></pre><div class="info">
Name of the volume.<br>
</div>
<pre><span id="VALget_key"><span class="keyword">val</span> get_key</span> : <code class="type">[ `R ] <a href="Libvirt.Volume.html#TYPEt">t</a> -> string</code></pre><div class="info">
Key of the volume.<br>
</div>
<pre><span id="VALget_path"><span class="keyword">val</span> get_path</span> : <code class="type">[ `R ] <a href="Libvirt.Volume.html#TYPEt">t</a> -> string</code></pre><div class="info">
Path of the volume.<br>
</div>
<pre><span id="VALget_info"><span class="keyword">val</span> get_info</span> : <code class="type">[ `R ] <a href="Libvirt.Volume.html#TYPEt">t</a> -> <a href="Libvirt.Volume.html#TYPEvol_info">vol_info</a></code></pre><div class="info">
Get information about the storage volume.<br>
</div>
<pre><span id="VALget_xml_desc"><span class="keyword">val</span> get_xml_desc</span> : <code class="type">[ `R ] <a href="Libvirt.Volume.html#TYPEt">t</a> -> <a href="Libvirt.html#TYPExml">Libvirt.xml</a></code></pre><div class="info">
Get the XML description.<br>
</div>
<pre><span id="VALcreate_xml"><span class="keyword">val</span> create_xml</span> : <code class="type">[ `W ] <a href="Libvirt.Pool.html#TYPEt">Libvirt.Pool.t</a> -> <a href="Libvirt.html#TYPExml">Libvirt.xml</a> -> unit</code></pre><div class="info">
Create a storage volume.<br>
</div>
<pre><span id="VALdelete"><span class="keyword">val</span> delete</span> : <code class="type">[ `W ] <a href="Libvirt.Volume.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Delete a storage volume.<br>
</div>
<pre><span id="VALfree"><span class="keyword">val</span> free</span> : <code class="type">[> `R ] <a href="Libvirt.Volume.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Free a storage volume object in memory.
<p>
The storage volume object is automatically freed if it is garbage
collected. This function just forces it to be freed right
away.<br>
</div>
<pre><span id="VALconst"><span class="keyword">val</span> const</span> : <code class="type">[> `R ] <a href="Libvirt.Volume.html#TYPEt">t</a> -> <a href="Libvirt.html#TYPEro">Libvirt.ro</a> <a href="Libvirt.Volume.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">const conn</code> turns a read/write storage volume into a read-only
volume. Note that the opposite operation is impossible.<br>
</div>
</body></html>
