Struct libgitdit::issue::Issue

pub struct Issue<'r> { /* fields omitted */ }

Issue handle

Instances of this type represent single issues. Issues reside in repositories and are uniquely identified by an id.

Methods

impl<'r> Issue<'r>

fn new(repo: &'r Repository, id: Oid) -> Result<Self>

Create a new handle for an issue with a given id

fn id(&self) -> Oid

Get the issue's id

fn initial_message(&self) -> Result<Commit<'r>>

Get the issue's initial message

fn heads(&self) -> Result<References<'r>>

Get possible heads of the issue

Returns the head references from both the local repository and remotes for this issue.

fn local_head(&self) -> Result<Reference<'r>>

Get the local issue head for the issue

Returns the head reference of the issue from the local repository, if present.

fn local_refs(&self, ref_type: IssueRefType) -> Result<References<'r>>

Get local references for the issue

Return all references of a specific type associated with the issue from the local repository.

fn remote_refs(&self, ref_type: IssueRefType) -> Result<References<'r>>

Get remote references for the issue

Return all references of a specific type associated with the issue from all remote repositories.

fn all_refs(&self, ref_type: IssueRefType) -> Result<References<'r>>

Get references for the issue

Return all references of a specific type associated with the issue from both the local and remote repositories.

fn messages(&self) -> Result<Messages<'r>>

Get all Messages of the issue

The sorting of the underlying revwalk will be set to "topological".

fn messages_from(&self, message: Oid) -> Result<Messages<'r>>

Get Messages of the issue starting from a specific one

The Messages iterator returned will return all first parents up to and includingthe initial message of the issue.

fn terminated_messages(&self) -> Result<Messages<'r>>

Prepare a Messages iterator which will terminate at the initial message

fn add_message<'a, A, I, J>(
    &self,
    author: &Signature,
    committer: &Signature,
    message: A,
    tree: &Tree,
    parents: I
) -> Result<Commit<'r>> where
    A: AsRef<str>,
    I: IntoIterator<Item = &'a Commit<'a>, IntoIter = J>,
    J: Iterator<Item = &'a Commit<'a>>, 

Add a new message to the issue

Adds a new message to the issue. Also create a leaf reference for the new message. Returns the message.

fn update_head(&self, message: Oid, replace: bool) -> Result<Reference<'r>>

Update the local head reference of the issue

Updates the local head reference of the issue to the provided message.

Warnings

The function will update the reference even if it would not be an fast-forward update.

fn add_leaf(&self, message: Oid) -> Result<Reference<'r>>

Add a new leaf reference associated with the issue

Creates a new leaf reference for the message provided in the issue.

fn ref_part(&self) -> String

Get reference part for this issue

The references associated with an issue reside in paths specific to the issue. This function returns the part unique for the issue, e.g. the part after the dit/.

Trait Implementations

impl<'r> Display for Issue<'r>

fn fmt(&self, f: &mut Formatter) -> RResult<(), Error>

Formats the value using the given formatter.

impl<'r> PartialEq for Issue<'r>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'r> Eq for Issue<'r>

impl<'r> Hash for Issue<'r>

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].