►Libgit2:   Bindings for the libgit2 git library
▼2 Functions
2.1 Annotated Commit
2.2 Blame
2.3 Blob
2.4 Branch
2.5 Buffer
2.6 Checkout
2.7 Cherrypick
2.8 Clone
2.9 Commit
2.10 Config
2.11 Credentials
2.12 Describe
2.13 Diff
2.14 Fetch
2.15 Filter
2.16 Errors
2.17 Graph
2.18 Ignore
2.19 Index
2.20 Indexer
2.21 Global
2.22 Merge
2.23 Message
2.24 Note
2.25 Object
2.26 Object Database
2.27 Oid
2.28 Oid Array
2.29 Packbuilder
2.30 Patch
2.31 Pathspec
2.32 Proxy
2.33 Push
2.34 Rebase
2.35 Refdb
2.36 Reference
2.37 Reflog
2.38 Refspec
2.39 Remote
2.40 Repository
2.41 Reset
2.42 Revert
2.43 Revparse
2.44 Revwalk
2.45 Signature
2.46 Stash
2.47 Status
2.48 Strarray
2.49 Submodule
2.50 Tag
2.51 Tree
2.52 Treebuilder
On this page:
git_  object_  _  size
git_  object_  dup
git_  object_  free
git_  object_  id
git_  object_  lookup
git_  object_  lookup_  bypath
git_  object_  lookup_  prefix
git_  object_  owner
git_  object_  peel
git_  object_  short_  id
git_  object_  string2type
git_  object_  type
git_  object_  type2string
git_  object_  typeisloose
7.7
  top  ← prev  up  next → 

2.25 Object

 (require libgit2/include/object) package: libgit2

procedure

(git_object__size type) → integer?

  type : git_otype
Get the size in bytes for the structure which acts as an in-memory representation of any given object type.

For all the core types, this would the equivalent of calling sizeof(git_commit) if the core types were not opaque on the external API.

procedure

(git_object_dup source) → object?

  source : object?
Create an in-memory copy of a Git object. The copy must be explicitly free’d or it will leak.

procedure

(git_object_free object) → void?

  object : object?
Close an open object

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 aggressive is the caching mechanism used by the repository.

IMPORTANT: It is necessary to call this method when you stop using an object. Failure to do so will cause a memory leak.

procedure

(git_object_id obj) → integer?

  obj : object?
Get the id (SHA1) of a repository object

procedure

(git_object_lookup repo id type) → object?

  repo : repository?
  id : oid?
  type : git_otype
Lookup a reference to one of the objects in a repository.

The generated reference is owned by the repository and should be closed with the git_object_free method instead of free’d manually.

The ’type’ parameter must match the type of the object in the odb; the method will fail otherwise. The special value ’GIT_OBJ_ANY’ may be passed to let the method guess the object’s type.

procedure

(git_object_lookup_bypath treeish path type) → object?

  treeish : object?
  path : string?
  type : git_otype
Lookup an object that represents a tree entry.

procedure

(git_object_lookup_prefix repo id len type) → object?

  repo : repository?
  id : oid?
  len : integer?
  type : git_otype
Lookup a reference to one of the objects in a repository, given a prefix of its identifier (short id).

The object obtained will be so that its identifier matches the first ’len’ hexadecimal characters (packets of 4 bits) of the given ’id’. ’len’ must be at least GIT_OID_MINPREFIXLEN, and long enough to identify a unique object matching the prefix; otherwise the method will fail.

The generated reference is owned by the repository and should be closed with the git_object_free method instead of free’d manually.

The ’type’ parameter must match the type of the object in the odb; the method will fail otherwise. The special value ’GIT_OBJ_ANY’ may be passed to let the method guess the object’s type.

procedure

(git_object_owner obj) → repository?

  obj : object?
Get the repository that owns this object

Freeing or calling git_repository_close on the returned pointer will invalidate the actual object.

Any other operation may be run on the repository without affecting the object.

procedure

(git_object_peel object target_type) → object?

  object : object?
  target_type : git_otype
Recursively peel an object until an object of the specified type is met.

If the query cannot be satisfied due to the object model, GIT_EINVALIDSPEC will be returned (e.g. trying to peel a blob to a tree).

If you pass GIT_OBJ_ANY as the target type, then the object will be peeled until the type changes. A tag will be peeled until the referenced object is no longer a tag, and a commit will be peeled to a tree. Any other object type will return GIT_EINVALIDSPEC.

If peeling a tag we discover an object which cannot be peeled to the target type due to the object model, GIT_EPEEL will be returned.

You must free the returned object.

procedure

(git_object_short_id out obj) → integer?

  out : buf?
  obj : object?
Get a short abbreviated OID string for the object

This starts at the "core.abbrev" length (default 7 characters) and iteratively extends to a longer string if that length is ambiguous. The result will be unambiguous (at least until new objects are added to the repository).

procedure

(git_object_string2type str) → git_otype

  str : string?
Convert a string object type representation to it’s git_otype.

procedure

(git_object_type obj) → git_otype?

  obj : object?
Get the object type of an object

procedure

(git_object_type2string type) → string?

  type : git_otype
Convert an object type to its string representation.

The result is a pointer to a string in static memory and should not be free()’ed.

procedure

(git_object_typeisloose type) → boolean?

  type : git_otype
Determine if the given git_otype is a valid loose object type.

  top  ← prev  up  next →