Struct MergeProposal 

pub struct MergeProposal(/* private fields */);

A merge proposal (pull request) on a code hosting service.

Implementations

impl MergeProposal

pub fn from_url(url: &Url) -> Result<MergeProposal, Error>

Create a merge proposal reference from a URL.

pub fn reopen(&self) -> Result<(), Error>

Reopens a previously closed merge proposal.

pub fn close(&self) -> Result<(), Error>

Closes an open merge proposal without merging it.

pub fn url(&self) -> Result<Url, Error>

Returns the URL of the merge proposal.

pub fn is_merged(&self) -> Result<bool, Error>

Checks if the merge proposal has been merged.

pub fn is_closed(&self) -> Result<bool, Error>

Checks if the merge proposal has been closed without being merged.

pub fn get_title(&self) -> Result<Option<String>, Error>

Retrieves the title of the merge proposal.

pub fn set_title(&self, title: Option<&str>) -> Result<(), Error>

Sets the title of the merge proposal.

pub fn get_commit_message(&self) -> Result<Option<String>, Error>

Retrieves the commit message associated with the merge proposal.

pub fn set_commit_message( &self, commit_message: Option<&str>, ) -> Result<(), Error>

Sets the commit message for the merge proposal.

pub fn get_target_branch_url(&self) -> Result<Option<Url>, Error>

Returns the URL of the target branch for this merge proposal.

pub fn get_source_branch_url(&self) -> Result<Option<Url>, Error>

Returns the URL of the source branch for this merge proposal.

pub fn get_description(&self) -> Result<Option<String>, Error>

Retrieves the description of the merge proposal.

pub fn set_description(&self, description: Option<&str>) -> Result<(), Error>

Sets the description of the merge proposal.

pub fn can_be_merged(&self) -> Result<bool, Error>

Checks if the merge proposal can currently be merged.

pub fn supports_auto_merge(&self) -> bool

Checks if the merge proposal supports automatic merging.

pub fn merge(&self, auto: bool) -> Result<(), Error>

Merges the merge proposal, optionally using automatic merge.

The auto parameter determines whether to use automatic merging.

pub fn get_web_url(&self) -> Result<Url, Error>

Returns the web URL for viewing the merge proposal in a browser.

pub fn get_merged_by(&self) -> Result<Option<String>, Error>

Returns the username of the person who merged this proposal, if it has been merged.

pub fn get_merged_at(&self) -> Result<Option<DateTime<Utc>>, Error>

Returns the date and time when this proposal was merged, if it has been merged.

Trait Implementations

impl Clone for MergeProposal

fn clone(&self) -> MergeProposal

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MergeProposal

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for MergeProposal

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<Py<PyAny>> for MergeProposal

fn from(obj: Py<PyAny>) -> MergeProposal

Converts to this type from the input type.