Struct AdsBuilder

pub struct AdsBuilder { /* private fields */ }

A builder that can be used to create an Ads interface with custom settings.

Example

use adsabs::Ads;
let api_token = "ADS_API_TOKEN";
let client = Ads::builder(api_token)
    .user_agent("my-user-agent")
    .build()?;

Implementations

impl AdsBuilder

pub fn new(token: &str) -> Self

Constructs a new AdsBuilder.

This is the same as Ads::builder.

pub fn from_env() -> Result<Self>

Constructs a new AdsBuilder, loading the API token from either environment valiables or the user’s home directory.

The following locations are checked, in the listed order:

1. The ADS_API_TOKEN environment variable,
2. The ADS_DEV_KEY environment variable,
3. The contents of the ~/.ads/token file, and
4. The contents of the ~/.ads/dev_key file.

These were chosen to be compatible with the locations supported by the Python client ads.

Errors

This method fails when the token cannot be loaded from any of the expected locations.

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

Sets the base API URL to be used by this client.

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

Sets the API token to be used by this client.

pub fn user_agent(self, user_agent: &str) -> Self

Sets the User-Agent header to be used by this client.

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

Build the Ads API client

Errors

This method fails when there are problems parsing any of the parameters into the right formats for reqwest.