Struct Forge 

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

Represents a code forge (hosting service) like GitHub, GitLab, etc.

Implementations

impl Forge

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

Retrieves a merge proposal by its URL.

pub fn get_web_url( &self, branch: &(dyn PyBranch + 'static), ) -> Result<Url, Error>

Returns the web URL for a given branch on this forge.

pub fn base_url(&self) -> Url

Returns the base URL of this forge.

pub fn forge_kind(&self) -> String

Returns the kind of forge (e.g., GitHub, GitLab).

pub fn forge_name(&self) -> String

Returns the name of the forge.

pub fn merge_proposal_description_format(&self) -> String

Returns the format used for merge proposal descriptions on this forge.

pub fn supports_merge_proposal_commit_message(&self) -> bool

Checks if this forge supports setting commit messages for merge proposals.

pub fn supports_merge_proposal_title(&self) -> bool

Checks if this forge supports setting titles for merge proposals.

pub fn supports_merge_proposal_labels(&self) -> bool

Checks if this forge supports adding labels to merge proposals.

pub fn get_proposer( &self, from_branch: &(dyn PyBranch + 'static), to_branch: &(dyn PyBranch + 'static), ) -> Result<ProposalBuilder, Error>

Creates a proposal builder for a merge proposal from one branch to another.

pub fn iter_my_proposals( &self, status: Option<MergeProposalStatus>, author: Option<String>, ) -> Result<impl Iterator<Item = MergeProposal>, Error>

Returns an iterator over merge proposals owned by the current user.

pub fn get_derived_branch( &self, main_branch: &(dyn PyBranch + 'static), name: &str, owner: Option<&str>, preferred_schemes: Option<&[&str]>, ) -> Result<Box<dyn Branch>, Error>

👎Deprecated since 0.7.7: Use get_derived_branch_as_generic instead to avoid unnecessary boxing

Gets a branch derived from a main branch with the given name and optional owner.

pub fn get_derived_branch_as_generic( &self, main_branch: &(dyn PyBranch + 'static), name: &str, owner: Option<&str>, preferred_schemes: Option<&[&str]>, ) -> Result<GenericBranch, Error>

Gets a branch derived from a main branch with the given name and optional owner, returning a GenericBranch.

This is similar to get_derived_branch, but returns a GenericBranch directly instead of boxing it as a trait object. This is more efficient and allows the caller to use GenericBranch-specific methods and traits like Clone.

pub fn iter_proposals( &self, source_branch: &(dyn PyBranch + 'static), target_branch: &(dyn PyBranch + 'static), status: MergeProposalStatus, ) -> Result<impl Iterator<Item = MergeProposal>, Error>

Returns an iterator over merge proposals from one branch to another.

pub fn publish_derived( &self, local_branch: &(dyn PyBranch + 'static), base_branch: &(dyn PyBranch + 'static), name: &str, overwrite: Option<bool>, owner: Option<&str>, revision_id: Option<&RevisionId>, tag_selector: Option<Box<dyn Fn(String) -> bool>>, ) -> Result<(Box<dyn Branch>, Url), Error>

Publishes a derived branch and returns the branch and its URL.

pub fn get_push_url(&self, branch: &(dyn PyBranch + 'static)) -> Url

Returns the URL for pushing to a branch on this forge.

pub fn get_user_url(&self, user: &str) -> Result<Url, Error>

Returns the URL for a user’s profile on this forge.

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

Returns the username of the currently authenticated user.

Trait Implementations

impl Clone for Forge

fn clone(&self) -> Forge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Forge

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

Formats the value using the given formatter.

impl Display for Forge

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

Formats the value using the given formatter.

impl From<Py<PyAny>> for Forge

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

Converts to this type from the input type.

impl<'a, 'py> FromPyObject<'a, 'py> for Forge

type Error = PyErr

The type returned in the event of a conversion error.

fn extract(ob: Borrowed<'a, 'py, PyAny>) -> Result<Forge, PyErr>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for Forge

type Target = PyAny

The Python output type

type Output = Bound<'py, <Forge as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = Infallible

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Forge as IntoPyObject<'py>>::Output, <Forge as IntoPyObject<'py>>::Error>

Performs the conversion.