Struct Ads

pub struct Ads { /* private fields */ }

An interface to the NASA ADS API.

This has various configuration values to tweak, but the most important one is token, which you’ll want to set to your ADS API token, which is available on your ADS settings page. To configure your Ads interface, use Ads::builder.

Examples

use adsabs::Ads;
let api_token = "ADS_API_TOKEN";
let client = Ads::new(api_token)?;

Implementations

impl Ads

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

Get an API client with a given token.

Errors

This method fails when AdsBuilder::build fails.

pub fn from_env() -> Result<Self>

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

Errors

This method fails when either AdsBuilder::build or AdsBuilder::from_env fails.

pub fn builder(token: &str) -> AdsBuilder

Constructs a new AdsBuilder so that the parameters of the Ads interface can be customized.

pub fn search(&self, query: &str) -> Query<'_>

Constructs a query for Search API endpoint that can be customized using a search::Query.

pub fn get<A, P>(&self, path: A, parameters: Option<&P>) -> Result<Response>

where A: AsRef<str>, P: Serialize + ?Sized,

Execute a general GET request to the API.

Errors

This method fails when the URL cannot be parsed or on HTTP errors.

Trait Implementations

impl Clone for Ads

fn clone(&self) -> Ads

Returns a duplicate of the value.

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

Performs copy-assignment from source.