pub struct GitHubIssueProvider<R: CommandRunner = RealCommandRunner> { /* private fields */ }Expand description
GitHub Issue 提供者,通过 gh CLI 操作。
该结构体通过调用 gh CLI 实现 IssueProvider trait 的所有方法,
使上层命令能够以统一的方式操作 GitHub Issue。
命令执行通过 CommandRunner 抽象,生产环境默认使用
RealCommandRunner,测试可注入自定义 runner 以模拟成功或失败场景。
§Examples
use gitflow_github::GitHubIssueProvider;
let provider = GitHubIssueProvider::new("octocat/hello-world");Implementations§
Source§impl<R: CommandRunner> GitHubIssueProvider<R>
impl<R: CommandRunner> GitHubIssueProvider<R>
Sourcepub fn with_runner(repo: impl Into<String>, runner: R) -> Self
pub fn with_runner(repo: impl Into<String>, runner: R) -> Self
使用自定义 CommandRunner 创建提供者。
主要用于测试,可注入模拟 runner 以控制 gh CLI 的输出。
repo 格式为 owner/repo。
Trait Implementations§
Source§impl<R: Clone + CommandRunner> Clone for GitHubIssueProvider<R>
impl<R: Clone + CommandRunner> Clone for GitHubIssueProvider<R>
Source§fn clone(&self) -> GitHubIssueProvider<R>
fn clone(&self) -> GitHubIssueProvider<R>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<R: Debug + CommandRunner> Debug for GitHubIssueProvider<R>
impl<R: Debug + CommandRunner> Debug for GitHubIssueProvider<R>
Source§impl<R: CommandRunner + 'static> IssueProvider for GitHubIssueProvider<R>
impl<R: CommandRunner + 'static> IssueProvider for GitHubIssueProvider<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,
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。
通过单次 gh api repos/{owner}/{repo}/issues/{number} -X PATCH -f state=closed
调用更新状态,并直接解析 REST 响应获得更新后的完整 Issue 数据。
该调用幂等:对已关闭的 Issue 再次关闭将成功返回其当前数据。
§设计说明(issue #117)
早期实现先调用 gh issue close,再用 gh issue view --json 重新获取详情。
该双调用设计有两个缺陷:
--json输出来自gh的 GraphQL 导出层,字段形状随gh版本漂移 (如 gh 2.94+ 的 bot author 省略id),导致反序列化失败;- 关闭操作已经成功时,二次获取的解析失败仍被误报为“关闭失败“。
改为单次 REST 调用后,变更与数据在同一响应中返回,两个缺陷同时消除。
REST 响应形状是 GitHub API 的稳定契约,bot 用户同样携带数字 id。
§Errors
当 Issue 不存在、gh 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,
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,
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,
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 上添加评论。
调用 gh api repos/{repo}/issues/{number}/comments -X POST 创建评论,
直接从 POST 响应中解析新创建的评论数据。
§Errors
当 Issue 不存在、body 为空或 gh CLI 调用失败时返回错误。
Source§fn list_comments<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<Vec<CommentData>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn list_comments<'life0, 'async_trait>(
&'life0 self,
number: u64,
) -> Pin<Box<dyn Future<Output = Result<Vec<CommentData>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
列出指定 Issue 的所有评论。
调用 gh api repos/{repo}/issues/{number}/comments 获取评论列表,
直接从响应中解析评论数据数组。
§Errors
当 Issue 不存在或 gh 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,
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,
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,
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 移除一个标签。
调用 gh issue edit <number> --repo <repo> --remove-label <label> 移除标签。
§Errors
当 Issue 不存在、标签未附加到该 Issue 或 gh 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,
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,
Auto Trait Implementations§
impl<R> Freeze for GitHubIssueProvider<R>where
R: Freeze,
impl<R> RefUnwindSafe for GitHubIssueProvider<R>where
R: RefUnwindSafe,
impl<R> Send for GitHubIssueProvider<R>
impl<R> Sync for GitHubIssueProvider<R>
impl<R> Unpin for GitHubIssueProvider<R>where
R: Unpin,
impl<R> UnsafeUnpin for GitHubIssueProvider<R>where
R: UnsafeUnpin,
impl<R> UnwindSafe for GitHubIssueProvider<R>where
R: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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