Struct taskcluster::ClientBuilder

pub struct ClientBuilder { /* private fields */ }

ClientBuilder implements the builder pattern for building a Client, allowing optional configuration of features such as authorized scopes and retry.

Implementations

impl ClientBuilder

pub fn new<S: Into<String>>(root_url: S) -> Self

Create a new ClientBuilder. The Taskcluster root URL is required and so must always be specified.

pub fn credentials(self, credentials: Credentials) -> Self

Add credentials to the client

pub fn retry(self, retry: Retry) -> Self

Set the retry configuration for the client

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

Set the timeout for each HTTP request made by the client. The default is 30 seconds.

pub fn authorized_scopes(
    self,
    authorized_scopes: impl IntoIterator<Item = impl AsRef<str>>
) -> Self

Set the authorized scopes for this client. These will be passed along with request, and included in signed URLs, and will act as a limit on the scopes available for the operation beyond those afforded by the credentials themselves.

pub fn build(self) -> Result<Client>

Build the resulting client, consuming the builder

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> ClientBuilder

Returns the “default value” for a type.

impl From<&'_ str> for ClientBuilder

fn from(root_url: &str) -> Self

Converts to this type from the input type.

impl From<String> for ClientBuilder

fn from(root_url: String) -> Self

Converts to this type from the input type.