Module Tag

Class "Tag". Extends Object

Functions

Object:free () Destroy this object (will be called by Garbage Collector).
Object:id () object method.
Object:owner () object method.
Object:type () object method.
Tag.lookup (repo, id) Create a new Tag object.
Tag:message () object method.
Tag:name () object method.
Tag:tagger () object method.
Tag:target () object method.


Functions

Object:free ()
Destroy this object (will be called by Garbage Collector).

Calls git_object_free:

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.

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

Object:id ()
object method.

Calls git_object_id:

Return value:

OID.
Object:owner ()
object method.

Calls git_object_owner:

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.

Return value:

Repository.
Object:type ()
object method.

Calls git_object_type:

Return value:

string.
Tag.lookup (repo, id)
Create a new Tag object.

Calls git_tag_lookup:

Parameters

  • repo: the repo to use when locating the tag.. Must be of type Repository.
  • id: identity of the tag to locate.. Must be of type OID.

Return values:

  1. Tag or nil on error.
  2. Error string.
Tag:message ()
object method.

Calls git_tag_message:

Return value:

string.
Tag:name ()
object method.

Calls git_tag_name:

Return value:

string.
Tag:tagger ()
object method.

Calls git_tag_tagger:

Return value:

Signature.
Tag:target ()
object method.

Calls git_tag_target:

This method performs a repository lookup for the given object and returns it

Return values:

  1. Object or nil on error.
  2. Error string.

Valid XHTML 1.0!