Struct Client 

pub struct Client { /* private fields */ }

A forge CLI bound to one project.

Implementations

impl Client

pub fn resolve( forge: Forge, target: &Utf8Path, repo: &str, ) -> Result<Self, RkError>

The client for forge, run from target, for project repo.

Errors

The resolution’s refusal, which names the client, where no usable binary resolves.

pub const fn forge(&self) -> Forge

The forge.

pub fn api(&self, method: &str, path: &str, body: Option<&Value>) -> Api

One api call, with a JSON body where one is given.

pub fn open_request( &self, base: &str, branch: &str, ) -> Result<Option<u64>, RkError>

The open request whose head is branch against base, by number.

Errors

A refusal where the forge does not answer.

pub fn merges_request( &self, sha: &str, base: &str, branch: &str, ) -> Result<bool, RkError>

Whether sha is the merge or squash commit of a merged request whose head is branch and whose base is base.

SATISFIES release-engine:a-final-version-releases-at-its-request

Errors

A refusal where the forge does not answer.

pub fn release(&self, tag: &str) -> Result<Option<Release>, RkError>

The release of tag, a draft included, where one exists.

Errors

A refusal where the forge does not answer.

pub fn tag(&self, tag: &str) -> TagAt

The commit tag names, in three states: present, absent, and a read that failed.

pub fn package_files(&self, version: &str) -> Result<Vec<Asset>, RkError>

Every file the GitLab generic package release holds at version, with its SHA-256.

Errors

A refusal where the forge does not answer.

pub fn identity(&self) -> Result<(String, String), RkError>

The name and the email of the account the client’s credential names.

SATISFIES bot-identity:the-bot-identity-reaches-one-project

GitHub answers the App’s bot account as the viewer of its installation token, and its email is the account’s noreply address. GitLab answers the token’s user, and a user with no public email takes its username’s noreply address on the instance.

Errors

A refusal where the forge does not answer.

pub fn create_request( &self, base: &str, branch: &str, title: &str, body: &str, ) -> Result<u64, RkError>

Open the request from branch into base.

Errors

The forge’s refusal.

pub fn edit_request( &self, number: u64, title: &str, body: &str, ) -> Result<(), RkError>

Edit the request’s title and description in place.

Errors

The forge’s refusal.

pub fn close_request(&self, number: u64) -> Result<(), RkError>

Close a request that has nothing left to release.

Errors

The forge’s refusal.

pub fn arm(&self, number: u64, form: MergeForm) -> Result<bool, RkError>

Arm the request to merge itself once its checks pass. On GitLab an arm the forge cannot take yet, before the request’s first pipeline starts, answers false and waits for the next refresh.

Errors

GitHub’s refusal.

pub fn create_draft( &self, tag: &str, sha: &str, notes: &str, candidate: bool, ) -> Result<String, RkError>

Create an unpublished draft release of tag at sha, which creates no tag, and answer its id.

Errors

The forge’s refusal.

pub fn upload( &self, tag: &str, files: &[Utf8PathBuf], clobber: bool, ) -> Result<(), RkError>

Upload files to the GitHub release of tag, replacing a same-name asset where clobber says so.

Errors

The forge’s refusal.

pub fn publish_draft( &self, id: &str, sha: &str, candidate: bool, ) -> Result<(), RkError>

Publish a draft at sha; the publication creates the tag there.

Errors

The forge’s refusal.

pub fn package_url(&self, version: &str, name: &str) -> String

The URL a GitLab generic package file is served from.

pub fn upload_package( &self, version: &str, file: &Utf8Path, ) -> Result<(), RkError>

Upload one file to the GitLab generic package release at version.

Errors

The forge’s refusal.

pub fn create_release( &self, tag: &str, sha: &str, description: &str, links: &[(String, String)], ) -> Result<(), RkError>

Create the GitLab release of tag at sha with every link, in one request; the release create creates the tag.

Errors

The forge’s refusal.

pub fn add_link(&self, tag: &str, name: &str, url: &str) -> Result<(), RkError>

Add one link to the GitLab release of tag.

Errors

The forge’s refusal.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.