Struct GitLab 

pub struct GitLab<R: ProcessRunner = JobRunner> { /* private fields */ }

The real GitLab client. Generic over the ProcessRunner so tests can inject a fake process executor; GitLab::new() uses the real job-backed runner.

Implementations

impl GitLab<JobRunner>

pub fn new() -> Self

Create a client driving the real job-backed runner.

impl<R: ProcessRunner> GitLab<R>

pub fn with_runner(runner: R) -> Self

Create a client driving runner — inject a fake in tests.

pub fn default_timeout(self, timeout: Duration) -> Self

Apply a default timeout to every command this client builds.

pub fn default_env( self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>, ) -> Self

Set an environment variable on every command this client builds (e.g. GIT_TERMINAL_PROMPT=0).

pub fn default_env_remove(self, key: impl AsRef<OsStr>) -> Self

Remove an inherited environment variable on every command this client builds.

impl<R: ProcessRunner> GitLab<R>

pub fn default_cancel_on(self, token: CancellationToken) -> Self

Cancel every command this client builds when token fires (a per-command cancel_on replaces the default — see CliClient::default_cancel_on).

impl<R: ProcessRunner> GitLab<R>

pub async fn run_args(&self, args: &[&str]) -> Result<String>

Run glab <args> over string slices — glab.run_args(&["mr", "list"]) without allocating a Vec<String>. Inherent (not on the object-safe trait), so it can take &[&str]; forwards to the same path as GitLabApi::run.

pub async fn run_raw_args(&self, args: &[&str]) -> Result<ProcessResult<String>>

Like run_args but never errors on a non-zero exit (mirrors GitLabApi::run_raw).

pub fn at<'a>(&'a self, dir: &'a Path) -> GitLabAt<'a, R>

Bind a working directory, so the project-scoped methods omit that argument: glab.at(dir).mr_list() runs mr_list against dir.

Trait Implementations

impl Default for GitLab<JobRunner>

fn default() -> Self

Returns the “default value” for a type.

impl<R: ProcessRunner> GitLabApi for GitLab<R>

fn run<'life0, 'life1, 'async_trait>( &'life0 self, args: &'life1 [String], ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Run glab <args>, returning trimmed stdout (throws on a non-zero exit).

fn run_raw<'life0, 'life1, 'async_trait>( &'life0 self, args: &'life1 [String], ) -> Pin<Box<dyn Future<Output = Result<ProcessResult<String>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Like GitLabApi::run but never errors on a non-zero exit — returns the captured ProcessResult.

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

where Self: 'async_trait, 'life0: 'async_trait,

Installed GitLab CLI version (glab --version).

fn auth_status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Whether the user is authenticated (glab auth status exits zero). Reflects the exit code as a bool — any non-zero exit reads as false, never an error; only a spawn failure or timeout errors.

fn repo_view<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Project>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The project for dir (glab repo view --output json).

fn mr_list<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<MergeRequest>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Open merge requests for dir (glab mr list --per-page 100 --output json). Returns up to 100 (100 is the GitLab API per-page max); use run for more.

fn mr_view<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, id: u64, ) -> Pin<Box<dyn Future<Output = Result<MergeRequest>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

A single merge request by its project-scoped id (glab mr view <id> --output json).

fn mr_create<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, spec: MrCreate, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Open a merge request, returning the command’s output (the MR URL on success) (glab mr create). The MrCreate spec carries the title, body, and the optional source (None = the current branch) and target (None = the project default) branches.

fn mr_merge<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, id: u64, strategy: MergeStrategy, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Merge a merge request immediately (glab mr merge <id> --yes --auto-merge=false [--squash|--rebase]) — --auto-merge=false overrides glab’s default of enabling merge-when-pipeline-succeeds. See MergeStrategy.

fn mr_ready<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, id: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Mark a draft merge request as ready (glab mr update <id> --ready).

fn mr_close<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, id: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Close a merge request without merging (glab mr close <id>).

fn mr_checks<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, id: u64, ) -> Pin<Box<dyn Future<Output = Result<CiStatus>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The MR’s pipeline status, bucketed (glab mr view <id> --output json, reading head_pipeline.status). CiStatus::None when no pipeline ran.

fn issue_list<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<Issue>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Open issues for dir (glab issue list --per-page 100 --output json). Returns up to 100 (100 is the GitLab API per-page max); use run for more.

fn issue_view<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, number: u64, ) -> Pin<Box<dyn Future<Output = Result<Issue>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

A single issue by its project-scoped id (iid) (glab issue view <number> --output json).

fn issue_create<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, dir: &'life1 Path, title: &'life2 str, body: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Open an issue, returning the command’s output (the issue URL on success) (glab issue create --title <t> --description <d> --yes). --yes skips glab’s interactive submission prompt — mirrors mr_create.

fn release_list<'life0, 'life1, 'async_trait>( &'life0 self, dir: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<Release>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Releases for dir (glab release list --per-page 100 --output json). Returns up to 100 (100 is the GitLab API per-page max); use run for more.

fn release_view<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, dir: &'life1 Path, tag: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Release>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

A single release by its tag (glab release view <tag> --output json). The tag is a bare positional, so it is guarded with reject_flag_like (a leading - or empty value is rejected before any process spawns).