Struct UbiBuilder

pub struct UbiBuilder<'a> { /* private fields */ }

UbiBuilder is used to create a Ubi instance.

Implementations

impl<'a> UbiBuilder<'a>

pub fn new() -> Self

Returns a new empty UbiBuilder.

pub fn project(self, project: &'a str) -> Self

Set the project to download from. This can either be just the org/name, like houseabsolute/precious, or the complete forge site URL to the project, like https://github.com/houseabsolute/precious or https://gitlab.com/gitlab-org/cli. It also accepts a URL to any page in the project, like https://github.com/houseabsolute/precious/releases.

You must set this or set url, but not both.

pub fn tag(self, tag: &'a str) -> Self

Set the tag to download. By default the most recent release is downloaded. You cannot set this with the url option.

pub fn url(self, url: &'a str) -> Self

Set the URL to download from. This can be provided instead of a project or tag. This will not use the forge site API, so you will never hit API limits. That in turn means you won’t have to set a token env var except when downloading a release from a private repo when the URL is set.

You must set this or set project, but not both.

pub fn install_dir(self, install_dir: PathBuf) -> Self

Set the directory to install the binary in. If not set, it will default to ./bin.

pub fn matching(self, matching: &'a str) -> Self

Set a string to match against the release filename when there are multiple files for your OS/arch, i.e. “gnu” or “musl”. Note that this is only used when there is more than one matching release filename for your OS/arch. If only one release asset matches your OS/arch, then this will be ignored.

pub fn exe(self, exe: &'a str) -> Self

Set the name of the executable to look for in archive files. By default this is the same as the project name, so for houseabsolute/precious we look for precious or precious.exe. When running on Windows the “.exe” suffix will be added as needed.

pub fn github_token(self, token: &'a str) -> Self

Set a GitHub token to use for API requests. If this is not set then this will be taken from the GITHUB_TOKEN env var if it is set.

pub fn gitlab_token(self, token: &'a str) -> Self

Set a GitLab token to use for API requests. If this is not set then this will be taken from the CI_JOB_TOKEN or GITLAB_TOKEN env var, if one of these is set. If both are set, then the value in CI_JOB_TOKEN will be used.

pub fn platform(self, platform: &'a Platform) -> Self

Set the platform to download for. If not set it will be determined based on the current platform’s OS/arch.

pub fn is_musl(self, is_musl: bool) -> Self

Set whether or not the platform uses musl as its libc. This is only relevant for Linux platforms. If this isn’t set then it will be determined based on the current platform’s libc. You cannot set this to true on a non-Linux platform.

pub fn forge(self, forge: ForgeType) -> Self

Set the forge type to use for fetching assets and release information. This determines which REST API is used to get information about releases and to download the release. If this isn’t set, then this will be determined from the hostname in the url, if that is set. Otherwise, the default is GitHub.

pub fn api_base_url(self, api_base_url: &'a str) -> Self

Set the base URL for the forge site’s API. This is useful for testing or if you want to operate against an Enterprise version of GitHub or GitLab. This should be something like https://github.my-corp.example.com/api/v4.

pub fn build(self) -> Result<Ubi<'a>>

Builds a new Ubi instance and returns it.

Errors

If you have tried to set incompatible options (setting a project or tag with a url) or you have not set required options (one of project or url), then this method will return an error.

Trait Implementations

impl<'a> Debug for UbiBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for UbiBuilder<'a>

fn default() -> UbiBuilder<'a>

Returns the “default value” for a type.