Skip to main content

GitCodePrProvider

Struct GitCodePrProvider 

Source
pub struct GitCodePrProvider<R: CommandRunner = RealCommandRunner> { /* private fields */ }
Expand description

GitCode Pull Request 提供者,通过 gitcode CLI 操作。

该结构体通过调用 gitcode CLI 实现 PrProvider trait 的所有方法, 使上层命令能够以统一的方式操作 GitCode Pull Request。

命令执行通过 CommandRunner 抽象,生产环境默认使用 RealCommandRunner,测试可注入自定义 runner 以模拟成功或失败场景。

§Examples

use gitflow_gitcode::GitCodePrProvider;

let provider = GitCodePrProvider::new("octocat/hello-world");

Implementations§

Source§

impl GitCodePrProvider<RealCommandRunner>

Source

pub fn new(repo: impl Into<String>) -> Self

创建新的 GitCode Pull Request 提供者。

repo 格式为 owner/repo。

Source

pub fn with_session(session: &Session) -> Self

Create a new provider from a shared Session.

This enables state reuse across multiple operations in workflow chains.

Source§

impl<R: CommandRunner> GitCodePrProvider<R>

Source

pub fn with_runner(repo: impl Into<String>, runner: R) -> Self

使用自定义 CommandRunner 创建提供者。

主要用于测试,可注入模拟 runner 以控制 gitcode CLI 的输出。 repo 格式为 owner/repo。

Trait Implementations§

Source§

impl<R: Clone + CommandRunner> Clone for GitCodePrProvider<R>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<R: Debug + CommandRunner> Debug for GitCodePrProvider<R>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<R: CommandRunner + Clone + 'static> PrProvider for GitCodePrProvider<R>

Source§

fn close<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

关闭指定编号的 PR。

调用 gitcode pr close <number> --repo <repo> --yes --json 关闭 PR。 该命令只返回精简确认对象(无 title 等字段),随后调用 Self::view 取回更新后的完整 PR 数据。

§Errors

当 PR 不存在、已关闭、gitcode CLI 调用失败,或关闭成功后 view() 失败时返回错误。

Source§

fn reopen<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

重新打开指定编号的 PR。

调用 gitcode pr reopen <number> --repo <repo> --yes --json 重新打开已关闭的 PR。 该命令只返回精简确认对象(无 title 等字段),随后调用 Self::view 取回更新后的完整 PR 数据。

§Errors

当 PR 不存在、未关闭、gitcode CLI 调用失败,或重新打开成功后 view() 失败时返回错误。

Source§

fn comment<'life0, 'life1, 'async_trait>( &'life0 self, number: u64, body: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<CommentData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

在指定 PR 上添加评论。

调用 gitcode pr comment <number> --repo <repo> --body "<body>" --json 发布评论,并返回新建评论的数据。

§Errors

当 PR 不存在、body 为空或 gitcode CLI 调用失败时返回错误。

Source§

fn merge<'life0, 'async_trait>( &'life0 self, number: u64, strategy: Option<MergeStrategy>, auto: bool, ) -> Pin<Box<dyn Future<Output = Result<MergeResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

合并指定编号的 PR。

调用 gitcode pr merge <number> --repo <repo> --yes [--method <strategy>] 合并 PR。strategy 映射到 gitcode 的 --method 参数 (merge / squash / rebase);未指定时使用平台默认策略。

GitCode CLI 无排队合并语义,auto = true 直接报错而非静默退化成 立即合并——否则调用方会以为合并已被 CI 把关。

§Errors

当 PR 不存在、存在冲突无法合并、请求了 auto 或 gitcode CLI 调用失败时返回错误。

Source§

fn checkout<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

在本地检出指定 PR 的分支。

调用 gc pr checkout <number> --repo <repo> 在本地工作区创建并切换到 PR 的来源分支。如果本地已存在该分支,则尝试更新它。

§Errors

当 PR 不存在、本地 git 操作失败或 gitcode CLI 调用失败时返回错误。

Source§

fn mark_ready<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

将草稿 PR 标记为可审查状态(ready for review)。

调用 gc pr ready <number> --repo <repo> 将草稿 PR 转为可审查状态, 并通过 gc pr view 重新获取更新后的 PR 数据。

§Errors

当 PR 不存在、不是草稿状态或 gitcode CLI 调用失败时返回错误。

Source§

fn mark_wip<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

将 PR 标记为草稿状态(work in progress)。

调用 gc pr convert-to-draft <number> --repo <repo> 将可审查的 PR 转为草稿, 并通过 gc pr view 重新获取更新后的 PR 数据。

§Errors

当 PR 不存在、已是草稿状态或 gitcode CLI 调用失败时返回错误。

Source§

fn sync_branch<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

同步 PR 的分支(将 base 分支的最新变更合入 head 分支)。

调用 gc pr update-branch <number> --repo <repo> 将 PR 的来源分支 更新到与目标分支的最新状态同步,解决分支过时问题。

§Errors

当 PR 不存在、同步存在冲突或 gitcode CLI 调用失败时返回错误。

Source§

fn diff<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

获取指定 PR 的统一差异格式(unified diff)文本。

调用 gc mr diff <number> -R <repo> 获取平台原生的 diff 输出, 可直接用于 git apply。

§Errors

当 PR 不存在或 gitcode CLI 调用失败时返回错误。

Source§

fn patch<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

获取指定 PR 的 patch 格式文本(含邮件头信息)。

调用 gc mr patch <number> -R <repo> 获取包含 commit 元数据的 patch 格式输出,可用于 git am。

§Errors

当 PR 不存在或 gitcode CLI 调用失败时返回错误。

Source§

fn default_branch<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

查询仓库配置的默认分支。

GitCode CLI 无对应查询能力(先例:merge --auto),直接返回 CoreError::Platform,不发起任何 CLI 调用。

§Errors

恒定返回错误:GitCode 平台不支持此查询。

Source§

fn create<'life0, 'async_trait>( &'life0 self, args: CreatePrArgs, ) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

创建一条新 PR,返回平台生成的完整数据。 Read more
Source§

fn list<'life0, 'async_trait>( &'life0 self, args: ListPrArgs, ) -> Pin<Box<dyn Future<Output = Result<Paged<PrData>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

根据过滤条件列出 PR 列表。 Read more
Source§

fn view<'life0, 'async_trait>( &'life0 self, number: u64, ) -> Pin<Box<dyn Future<Output = Result<PrData>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

查看指定编号的 PR 详情。 Read more

Auto Trait Implementations§

§

impl<R> Freeze for GitCodePrProvider<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for GitCodePrProvider<R>
where R: RefUnwindSafe,

§

impl<R> Send for GitCodePrProvider<R>

§

impl<R> Sync for GitCodePrProvider<R>

§

impl<R> Unpin for GitCodePrProvider<R>
where R: Unpin,

§

impl<R> UnsafeUnpin for GitCodePrProvider<R>
where R: UnsafeUnpin,

§

impl<R> UnwindSafe for GitCodePrProvider<R>
where R: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more