Struct git2::Object [−][src]
pub struct Object<'repo> { /* fields omitted */ }
A structure to represent a git object
Methods
impl<'repo> Object<'repo>
[src]
impl<'repo> Object<'repo>
pub fn id(&self) -> Oid
[src]
pub fn id(&self) -> Oid
Get the id (SHA1) of a repository object
pub fn kind(&self) -> Option<ObjectType>
[src]
pub fn kind(&self) -> Option<ObjectType>
Get the object type of an object.
If the type is unknown, then None
is returned.
pub fn peel(&self, kind: ObjectType) -> Result<Object<'repo>, Error>
[src]
pub fn peel(&self, kind: ObjectType) -> Result<Object<'repo>, Error>
Recursively peel an object until an object of the specified type is met.
If you pass Any
as the target type, then the object will be
peeled until the type changes (e.g. a tag will be chased until the
referenced object is no longer a tag).
pub fn peel_to_blob(&self) -> Result<Blob<'repo>, Error>
[src]
pub fn peel_to_blob(&self) -> Result<Blob<'repo>, Error>
Recursively peel an object until a blob is found
pub fn peel_to_commit(&self) -> Result<Commit<'repo>, Error>
[src]
pub fn peel_to_commit(&self) -> Result<Commit<'repo>, Error>
Recursively peel an object until a commit is found
pub fn peel_to_tag(&self) -> Result<Tag<'repo>, Error>
[src]
pub fn peel_to_tag(&self) -> Result<Tag<'repo>, Error>
Recursively peel an object until a tag is found
pub fn peel_to_tree(&self) -> Result<Tree<'repo>, Error>
[src]
pub fn peel_to_tree(&self) -> Result<Tree<'repo>, Error>
Recursively peel an object until a tree is found
pub fn short_id(&self) -> Result<Buf, Error>
[src]
pub fn short_id(&self) -> Result<Buf, Error>
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).
pub fn as_commit(&self) -> Option<&Commit<'repo>>
[src]
pub fn as_commit(&self) -> Option<&Commit<'repo>>
Attempt to view this object as a commit.
Returns None
if the object is not actually a commit.
pub fn into_commit(self) -> Result<Commit<'repo>, Object<'repo>>
[src]
pub fn into_commit(self) -> Result<Commit<'repo>, Object<'repo>>
Attempt to consume this object and return a commit.
Returns Err(self)
if this object is not actually a commit.
pub fn as_tag(&self) -> Option<&Tag<'repo>>
[src]
pub fn as_tag(&self) -> Option<&Tag<'repo>>
Attempt to view this object as a tag.
Returns None
if the object is not actually a tag.
pub fn into_tag(self) -> Result<Tag<'repo>, Object<'repo>>
[src]
pub fn into_tag(self) -> Result<Tag<'repo>, Object<'repo>>
Attempt to consume this object and return a tag.
Returns Err(self)
if this object is not actually a tag.
pub fn as_tree(&self) -> Option<&Tree<'repo>>
[src]
pub fn as_tree(&self) -> Option<&Tree<'repo>>
Attempt to view this object as a tree.
Returns None
if the object is not actually a tree.
pub fn into_tree(self) -> Result<Tree<'repo>, Object<'repo>>
[src]
pub fn into_tree(self) -> Result<Tree<'repo>, Object<'repo>>
Attempt to consume this object and return a tree.
Returns Err(self)
if this object is not actually a tree.
pub fn as_blob(&self) -> Option<&Blob<'repo>>
[src]
pub fn as_blob(&self) -> Option<&Blob<'repo>>
Attempt to view this object as a blob.
Returns None
if the object is not actually a blob.
pub fn into_blob(self) -> Result<Blob<'repo>, Object<'repo>>
[src]
pub fn into_blob(self) -> Result<Blob<'repo>, Object<'repo>>
Attempt to consume this object and return a blob.
Returns Err(self)
if this object is not actually a blob.
pub fn describe(&self, opts: &DescribeOptions) -> Result<Describe, Error>
[src]
pub fn describe(&self, opts: &DescribeOptions) -> Result<Describe, Error>
Describes a commit
Performs a describe operation on this commitish object.
Trait Implementations
impl<'repo> Clone for Object<'repo>
[src]
impl<'repo> Clone for Object<'repo>
fn clone(&self) -> Object<'repo>
[src]
fn clone(&self) -> Object<'repo>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl<'repo> Debug for Object<'repo>
[src]
impl<'repo> Debug for Object<'repo>
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<'repo> Drop for Object<'repo>
[src]
impl<'repo> Drop for Object<'repo>