docs/git2/OdbObject.luadoc


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

--
-- Warning: AUTOGENERATED DOCS.
--

--- Class "OdbObject".
--
module("OdbObject")

--- Destroy this object (will be called by Garbage Collector).
--
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_free">git_odb_object_free</a>:<p><p>This method must always be called once a `git_odb_object` is no
--  longer needed, otherwise memory will leak.
-- @name OdbObject:free
function OdbObject:free()
end

--- object method.
--
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_id">git_odb_object_id</a>:<p><p>This is the OID from which the object was read from
-- @return <a href="OID.html">OID</a>.
-- @name OdbObject:id
function OdbObject:id()
end

--- object method.
--
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_data">git_odb_object_data</a>:<p><p>This is the uncompressed, raw data as read from the ODB,
--  without the leading header.<p> This pointer is owned by the object and shall not be free'd.
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_size">git_odb_object_size</a>:<p><p>This is the real size of the `data` buffer, not the
--  actual size of the object.
-- @return <code>string</code>.
-- @name OdbObject:data
function OdbObject:data()
end

--- object method.
--
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_size">git_odb_object_size</a>:<p><p>This is the real size of the `data` buffer, not the
--  actual size of the object.
-- @return <code>integer</code>.
-- @name OdbObject:size
function OdbObject:size()
end

--- object method.
--
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_type">git_odb_object_type</a>:<p><p>
-- @return <code>string</code>.
-- @name OdbObject:type
function OdbObject:type()
end