Skip to main content

GitLabIssueProvider

Struct GitLabIssueProvider 

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

GitLab Issue 提供者,通过 glab CLI 操作。

该结构体通过调用 glab CLI 实现 IssueProvider trait 的所有方法, 使上层命令能够以统一的方式操作 GitLab Issue。

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

§Examples

use gitflow_gitlab::GitLabIssueProvider;

let provider = GitLabIssueProvider::new("gitlab-org/gitlab");

Implementations§

Source§

impl GitLabIssueProvider<RealCommandRunner>

Source

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

创建新的 GitLab Issue 提供者,使用真实的进程执行器。

repo 格式为 namespace/project。

Source§

impl<R: CommandRunner> GitLabIssueProvider<R>

Source

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

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

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

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> GitLabIssueProvider<R>

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 GitLabIssueProvider<R>

Source§

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

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

impl<R: CommandRunner + 'static> IssueProvider for GitLabIssueProvider<R>

Source§

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

关闭指定编号的 Issue。

调用 glab issue close <number> --repo <repo> --output json 关闭 Issue, 并返回更新后的完整 Issue 数据。

§Errors

当 Issue 不存在、已关闭或 glab CLI 调用失败时返回错误。

Source§

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

重新打开指定编号的 Issue。

调用 glab issue reopen <number> --repo <repo> --output json 重新打开已关闭的 Issue, 并返回更新后的完整 Issue 数据。

§Errors

当 Issue 不存在、未关闭或 glab CLI 调用失败时返回错误。

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,

在指定 Issue 上添加评论。

调用 glab issue note <number> --repo <repo> --body "<body>" --output json 发布评论, 并返回评论文数据。

§Errors

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

Source§

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

为指定 Issue 添加一个或多个标签。

调用 glab issue edit <number> --repo <repo> --add-label <labels> 添加标签, 多个标签以逗号连接后一次性提交。

§自动创建缺失标签

当 glab issue edit --add-label 因标签不存在而失败时,本方法会自动调用 glab label create 创建缺失的标签(使用默认颜色 ededed),然后重试原操作。

§Errors

当 Issue 不存在、标签创建失败或 glab CLI 调用失败时返回错误。

Source§

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

从指定 Issue 移除一个标签。

调用 glab issue edit <number> --repo <repo> --remove-label <label> 移除标签。

§Errors

当 Issue 不存在、标签未附加到该 Issue 或 glab CLI 调用失败时返回错误。

Source§

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

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

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

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

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

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

Auto Trait Implementations§

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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