diff options
Diffstat (limited to 'docs/modules/Blob.html')
| -rw-r--r-- | docs/modules/Blob.html | 456 |
1 files changed, 456 insertions, 0 deletions
diff --git a/docs/modules/Blob.html b/docs/modules/Blob.html new file mode 100644 index 0000000..5e01c97 --- /dev/null +++ b/docs/modules/Blob.html @@ -0,0 +1,456 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<head> + <title>Reference</title> + <link rel="stylesheet" href="../luadoc.css" type="text/css" /> + <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/--> +</head> + +<body> +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + +<div id="main"> + +<div id="navigation"> + + +<h1>LuaDoc</h1> +<ul> + + <li><a href="../index.html">Index</a></li> + +</ul> + + +<!-- Module list --> + +<h1>Modules</h1> +<ul> + + <li><strong>Blob</strong></li> + + <li> + <a href="../modules/Commit.html">Commit</a> + </li> + + <li> + <a href="../modules/Config.html">Config</a> + </li> + + <li> + <a href="../modules/Index.html">Index</a> + </li> + + <li> + <a href="../modules/IndexEntry.html">IndexEntry</a> + </li> + + <li> + <a href="../modules/IndexEntryUnmerged.html">IndexEntryUnmerged</a> + </li> + + <li> + <a href="../modules/ODB.html">ODB</a> + </li> + + <li> + <a href="../modules/ODBBackend.html">ODBBackend</a> + </li> + + <li> + <a href="../modules/OID.html">OID</a> + </li> + + <li> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </li> + + <li> + <a href="../modules/Object.html">Object</a> + </li> + + <li> + <a href="../modules/OdbObject.html">OdbObject</a> + </li> + + <li> + <a href="../modules/Reference.html">Reference</a> + </li> + + <li> + <a href="../modules/Repository.html">Repository</a> + </li> + + <li> + <a href="../modules/RevWalk.html">RevWalk</a> + </li> + + <li> + <a href="../modules/Signature.html">Signature</a> + </li> + + <li> + <a href="../modules/StrArray.html">StrArray</a> + </li> + + <li> + <a href="../modules/Tag.html">Tag</a> + </li> + + <li> + <a href="../modules/Tree.html">Tree</a> + </li> + + <li> + <a href="../modules/TreeEntry.html">TreeEntry</a> + </li> + + <li> + <a href="../modules/git2.html">git2</a> + </li> + +</ul> + + + +<!-- File list --> + + + + + + +</div><!-- id="navigation" --> + +<div id="content"> + +<h1>Module <code>Blob</code></h1> + +<p>Class "Blob". Extends <a href="Object.html">Object</a><br /></p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Blob.frombuffer">Blob.frombuffer</a> (repo, buffer)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Blob.fromfile">Blob.fromfile</a> (repo, path)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Blob.lookup">Blob.lookup</a> (repo, id)</td> + <td class="summary">Create a new Blob object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Blob:rawcontent">Blob:rawcontent</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Blob:rawsize">Blob:rawsize</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:free">Object:free</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:id">Object:id</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:owner">Object:owner</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:type">Object:type</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Blob.frombuffer"></a><strong>Blob.frombuffer</strong> (repo, buffer)</dt> +<dd> +module function. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_create_frombuffer">git_blob_create_frombuffer</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + repo: repository where to blob will be written. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + buffer: data to be written into the blob. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OID.html">OID</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Blob.fromfile"></a><strong>Blob.fromfile</strong> (repo, path)</dt> +<dd> +module function. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_create_fromfile">git_blob_create_fromfile</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + repo: repository where the blob will be written. this repository cannot be bare. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + path: file from which the blob will be created, relative to the repository's working dir. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OID.html">OID</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Blob.lookup"></a><strong>Blob.lookup</strong> (repo, id)</dt> +<dd> +Create a new Blob object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_lookup">git_blob_lookup</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + repo: the repo to use when locating the blob.. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + id: identity of the blob to locate.. Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Blob.html">Blob</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Blob:rawcontent"></a><strong>Blob:rawcontent</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawcontent">git_blob_rawcontent</a>:<p><p>A pointer to the raw content of a blob is returned; this pointer is owned internally by the object and shall not be free'd. The pointer may be invalidated at a later time. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawsize">git_blob_rawsize</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Blob:rawsize"></a><strong>Blob:rawsize</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawsize">git_blob_rawsize</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="Object:free"></a><strong>Object:free</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.<p> IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. + + + + + + + + + +</dd> + + + + +<dt><a name="Object:id"></a><strong>Object:id</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="Object:owner"></a><strong>Object:owner</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.<p> Any other operation may be run on the repository without affecting the object. + + + + + + + +<h3>Return value:</h3> +<a href="Repository.html">Repository</a>. + + + +</dd> + + + + +<dt><a name="Object:type"></a><strong>Object:type</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + +</dl> + + + + + + +</div> <!-- id="content" --> + +</div> <!-- id="main" --> + +<div id="about"> + <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> +</div> <!-- id="about" --> + +</div> <!-- id="container" --> +</body> +</html> |