[][src]Struct git2::Reference

pub struct Reference<'repo> { /* fields omitted */ }

A structure to represent a git reference.

Methods

impl<'repo> Reference<'repo>
[src]

Ensure the reference name is well-formed.

Get access to the underlying raw pointer.

Delete an existing reference.

This method works for both direct and symbolic references. The reference will be immediately removed on disk.

This function will return an error if the reference has changed from the time it was looked up.

Check if a reference is a local branch.

Check if a reference is a note.

Check if a reference is a remote tracking branch

Check if a reference is a tag

Get the reference type of a reference.

If the type is unknown, then None is returned.

Get the full name of a reference.

Returns None if the name is not valid utf-8.

Get the full name of a reference.

Get the full shorthand of a reference.

This will transform the reference name into a name "human-readable" version. If no shortname is appropriate, it will return the full name.

Returns None if the shorthand is not valid utf-8.

Get the full shorthand of a reference.

Get the OID pointed to by a direct reference.

Only available if the reference is direct (i.e. an object id reference, not a symbolic one).

Return the peeled OID target of this reference.

This peeled OID only applies to direct references that point to a hard Tag object: it is the result of peeling such Tag.

Get full name to the reference pointed to by a symbolic reference.

May return None if the reference is either not symbolic or not a valid utf-8 string.

Get full name to the reference pointed to by a symbolic reference.

Only available if the reference is symbolic.

Resolve a symbolic reference to a direct reference.

This method iteratively peels a symbolic reference until it resolves to a direct reference to an OID.

If a direct reference is passed as an argument, a copy of that reference is returned.

Peel a reference to an object

This method recursively peels the reference until it reaches an object of the specified type.

Peel a reference to a blob

This method recursively peels the reference until it reaches a blob.

Peel a reference to a commit

This method recursively peels the reference until it reaches a blob.

Peel a reference to a tree

This method recursively peels the reference until it reaches a blob.

Peel a reference to a tag

This method recursively peels the reference until it reaches a tag.

Rename an existing reference.

This method works for both direct and symbolic references.

If the force flag is not enabled, and there's already a reference with the given name, the renaming will fail.

Conditionally create a new reference with the same name as the given reference but a different OID target. The reference must be a direct reference, otherwise this will fail.

The new reference will be written to disk, overwriting the given reference.

Trait Implementations

impl<'repo> Drop for Reference<'repo>
[src]

impl<'repo> Eq for Reference<'repo>
[src]

impl<'repo> PartialOrd<Reference<'repo>> for Reference<'repo>
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<'repo> PartialEq<Reference<'repo>> for Reference<'repo>
[src]

This method tests for !=.

impl<'repo> Ord for Reference<'repo>
[src]

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Auto Trait Implementations

impl<'repo> !Send for Reference<'repo>

impl<'repo> !Sync for Reference<'repo>

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]